Installation

System Requirements

Minimum Requirements

Component	Requirement
Operating System	Windows 10 (Build 17763+) or Windows Server 2019+
RAM	256 MB (minimal overhead)
Disk Space	50 MB for binaries
Network	TCP connectivity (port 2022 by default)

ConPTY support requires Windows 10 Build 17763 (October 2018 Update) or later.

Recommended Requirements

Windows 10 21H2 or later / Windows 11
Windows Terminal (for best terminal experience)
Dedicated network port for the server
Administrator access (for Windows Service installation)

Installation Methods

Binary Release (Recommended)
Build from Source
Package Manager

Download Pre-Built Binaries

Download

Visit the GitHub Releases page and download the latest undying-terminal-X.X.X-win64.zip.

Extract

Extract the archive to your preferred location:

# PowerShell
Expand-Archive -Path undying-terminal-1.0.0-win64.zip -DestinationPath "C:\Program Files\UndyingTerminal"

Verify

Check that all executables are present:

ls "C:\Program Files\UndyingTerminal"

Expected files:

undying-terminal.exe (client)
undying-terminal-server.exe (server)
undying-terminal-terminal.exe (terminal)
Required DLLs (libsodium, OpenSSL, etc.)

Add to PATH (Optional)

For system-wide access:

# PowerShell (Run as Administrator)
$installPath = "C:\Program Files\UndyingTerminal"
$currentPath = [Environment]::GetEnvironmentVariable('Path', 'Machine')
$newPath = "$currentPath;$installPath"
[Environment]::SetEnvironmentVariable('Path', $newPath, 'Machine')

# Refresh current session
$env:Path = [Environment]::GetEnvironmentVariable('Path', 'Machine')

Build from Source

Prerequisites

Install required build tools:

Visual Studio 2019+ (with C++ Desktop Development workload)
CMake 3.20+
vcpkg (for dependencies)
Git

# Install vcpkg
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
.\bootstrap-vcpkg.bat
.\vcpkg integrate install

Clone Repository

git clone https://github.com/Microck/UndyingTerminal.git
cd undyingterminal

Install Dependencies

vcpkg will automatically install dependencies listed in vcpkg.json:

OpenSSL
libsodium
Protobuf

# Automatic via CMake integration
cmake --preset windows

Build

# Configure
cmake --preset windows

# Build (Release)
cmake --build --preset windows --config Release

# Output will be in: build/Release/

Run Tests (Optional)

cd build
ctest -C Release --output-on-failure

For MSYS2/MinGW builds, use the windows-mingw-msys2 preset:

cmake --preset windows-mingw-msys2
cmake --build build-mingw

Initial Setup

1. Server Setup

Create Configuration Directory

# PowerShell (Run as Administrator)
$configDir = "$env:PROGRAMDATA\UndyingTerminal"
New-Item -ItemType Directory -Force -Path $configDir

Create Configuration File

Create ut.cfg in the config directory:

$configFile = "$env:PROGRAMDATA\UndyingTerminal\ut.cfg"

@"
# Undying Terminal Server Configuration

# Server listen port (default: 2022)
port=2022

# Bind IP (0.0.0.0 = all interfaces)
bind_ip=0.0.0.0

# Verbose logging (true/false)
verbose=false

# Optional: Shared encryption key (hex)
# shared_key_hex=<generate-this>
"@ | Out-File -FilePath $configFile -Encoding ASCII

Configure Firewall

Allow inbound connections on port 2022:

# Run server with --add-firewall once
./undying-terminal-server.exe --add-firewall

# PowerShell (Run as Administrator)
New-NetFirewallRule `
  -DisplayName "Undying Terminal Server" `
  -Direction Inbound `
  -Protocol TCP `
  -LocalPort 2022 `
  -Action Allow `
  -Profile Any

Start Server (Test)

./undying-terminal-server.exe

Expected output:

[INFO] Loading config from: C:\ProgramData\UndyingTerminal\ut.cfg
[INFO] Server listening on 0.0.0.0:2022
[INFO] Named pipe server started: \\.\pipe\undying-terminal

2. Windows Service Installation (Production)

For production environments, run the server as a Windows service:

# PowerShell (Run as Administrator)
sc.exe create UndyingTerminalServer `
  binPath= "C:\Program Files\UndyingTerminal\undying-terminal-server.exe --service" `
  start= auto `
  DisplayName= "Undying Terminal Server"

# Start the service
sc.exe start UndyingTerminalServer

# Check service status
sc.exe query UndyingTerminalServer

# View service properties
Get-Service UndyingTerminalServer | Format-List *

# Stop and remove service
sc.exe stop UndyingTerminalServer
sc.exe delete UndyingTerminalServer

Service mode automatically handles job object cleanup and runs with system privileges.

3. Client Setup

No special setup required for the client! Just run:

./undying-terminal.exe --help

Verification

Test Local Connection

Start Server

# Terminal 1
./undying-terminal-server.exe

Start Terminal

# Terminal 2
echo "test/ignored" | ./undying-terminal-terminal.exe

Note the client_id and passkey from output.

Connect Client

# Terminal 3
./undying-terminal.exe `
  --connect 127.0.0.1 2022 <CLIENT_ID> `
  --key <PASSKEY> `
  --noexit

Test Session

Type dir or ls and verify output appears.

If you see command output, installation is successful!

Network Configuration

Port Forwarding (Router/Firewall)

To access the server from outside your local network:

Find Server IP

# Internal IP
ipconfig | findstr IPv4

# External IP (public)
(Invoke-WebRequest -Uri "https://api.ipify.org").Content

Configure Port Forwarding

In your router:

Forward external port 2022 → internal IP:2022
Use TCP protocol
Enable the rule

Test External Access

# From external network
./undying-terminal.exe --connect <PUBLIC_IP> 2022 <CLIENT_ID> --key <PASSKEY>

Security Recommendation: Enable shared key encryption when exposing the server to the internet. See Configuration → Encryption.

Optional Enhancements

Generate Encryption Key

For production deployments with encryption:

# Generate random 32-byte hex key
$bytes = New-Object byte[] 32
[Security.Cryptography.RNGCryptoServiceProvider]::Create().GetBytes($bytes)
$hexKey = -join ($bytes | ForEach-Object { $_.ToString("x2") })
Write-Output "shared_key_hex=$hexKey"

# Add to ut.cfg

Install Dependencies (MSYS2)

If using MSYS2 builds:

# MSYS2 MINGW64 shell
pacman -S mingw-w64-x86_64-cmake \
          mingw-w64-x86_64-gcc \
          mingw-w64-x86_64-protobuf \
          mingw-w64-x86_64-libsodium \
          mingw-w64-x86_64-openssl

Troubleshooting Installation

Missing DLL errors

If you see errors like:

The code execution cannot proceed because libsodium.dll was not found.

Solution:

Ensure all DLLs from the release package are in the same directory as the executables
Check PATH includes the installation directory
Reinstall Visual C++ Redistributable (2015-2022)

Build errors with vcpkg

If CMake can’t find dependencies:

# Ensure vcpkg integration is active
cd \path\to\vcpkg
.\vcpkg integrate install

# Point CMake to vcpkg
cmake -DCMAKE_TOOLCHAIN_FILE=\path\to\vcpkg\scripts\buildsystems\vcpkg.cmake ..

ConPTY not available

Error: CreatePseudoConsole failedCause: Windows version < Build 17763Solution: Update Windows to October 2018 Update (Build 17763) or later

Port 2022 already in use

Check what’s using the port:

netstat -ano | findstr :2022

Options:

Kill the conflicting process
Change port in ut.cfg
Use --port flag: ./undying-terminal-server.exe --port 2023

Next Steps

Quick Start Guide

Start using Undying Terminal

Server Configuration

Configure advanced server options

Windows Service Setup

Run as a Windows service

Building from Source

Detailed build instructions

System Integration Checklist

Before deploying to production:

Installed binaries to C:\Program Files\UndyingTerminal
Created config file at %PROGRAMDATA%\UndyingTerminal\ut.cfg
Configured firewall rule (auto or manual)
Tested local connection (server → terminal → client)
Generated encryption key (for external access)
Installed as Windows service (optional)
Configured port forwarding (if remote access needed)
Tested remote connection (if applicable)
Set up monitoring/logging (optional)

Getting Started

Core Concepts

Configuration

Troubleshooting

Development

System Requirements

Minimum Requirements

Recommended Requirements

Installation Methods

Download Pre-Built Binaries

Build from Source

Package Manager Installation

Initial Setup

1. Server Setup

2. Windows Service Installation (Production)

3. Client Setup

Verification

Test Local Connection

Network Configuration

Port Forwarding (Router/Firewall)

Optional Enhancements

Generate Encryption Key

Install Dependencies (MSYS2)

Troubleshooting Installation

Next Steps

Quick Start Guide

Server Configuration

Windows Service Setup

Building from Source

System Integration Checklist

​System Requirements

​Minimum Requirements

​Recommended Requirements

​Installation Methods

​Download Pre-Built Binaries

​Build from Source

​Package Manager Installation

​Initial Setup

​1. Server Setup

​2. Windows Service Installation (Production)

​3. Client Setup

​Verification

​Test Local Connection

​Network Configuration

​Port Forwarding (Router/Firewall)

​Optional Enhancements

​Generate Encryption Key

​Install Dependencies (MSYS2)

​Troubleshooting Installation

​Next Steps

Quick Start Guide

Server Configuration

Windows Service Setup

Building from Source

​System Integration Checklist

System Requirements

Minimum Requirements

Recommended Requirements

Installation Methods

Download Pre-Built Binaries

Build from Source

Package Manager Installation

Initial Setup

1. Server Setup

2. Windows Service Installation (Production)

3. Client Setup

Verification

Test Local Connection

Network Configuration

Port Forwarding (Router/Firewall)

Optional Enhancements

Generate Encryption Key

Install Dependencies (MSYS2)

Troubleshooting Installation

Next Steps

System Integration Checklist