Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

Nexterm ships as Docker images and requires no external runtime dependencies. Choosing the right image and network topology ensures Nexterm can reach all the servers on your network while keeping your deployment as simple as possible.

​
Available images

ImageContentsBest for
nexterm/aioServer, web client, and engine in one containerSingle-host deployments where all your servers are on the same network
nexterm/serverNode.js backend and web client onlyMulti-network setups where you need one or more separate engines
nexterm/engineConnection engine only (SSH, VNC, RDP, Telnet)Deploying an engine on a different network segment to reach isolated servers

​
Choosing a topology

​
All-in-one (most deployments)

Use nexterm/aio when all the servers you want to manage are reachable from a single host. This is the simplest setup — one container, one volume, one port. Recommended network mode: host Host networking gives the container direct access to your host’s network stack. This is required for:
  • Wake-on-LAN (must broadcast on the local network segment)
  • Connecting to servers via localhost or 127.0.0.1
  • Reaching hosts on link-local or other non-routable addresses
docker run -d \
  -e ENCRYPTION_KEY=your-encryption-key \
  --network host \
  --name nexterm \
  --restart always \
  -v nexterm:/app/data \
  nexterm/aio:latest

​
Split server + engine (multi-network)

Use nexterm/server and nexterm/engine as separate containers when your servers live on different network segments and no single host can reach all of them. A common pattern:
  • nexterm/server runs on a publicly accessible host (or behind a reverse proxy)
  • One or more nexterm/engine instances run on hosts inside private networks, each able to reach a different set of servers
  • Each engine connects outward to the server on port 7800 — no inbound ports needed on the engine host
services:
  server:
    image: nexterm/server:latest
    environment:
      ENCRYPTION_KEY: "your-encryption-key"
    ports:
      - "6989:6989"
    restart: always
    volumes:
      - nexterm:/app/data

  engine:
    image: nexterm/engine:latest
    restart: always
    volumes:
      - ./config.yaml:/etc/nexterm/config.yaml

volumes:
  nexterm:
The engine config.yaml points back to the server: 
server_host: "server"
server_port: 7800
registration_token: ""

​
Persistent data

All Nexterm state lives under /app/data inside the container. Always mount a volume to that path: 
volumes:
  - nexterm:/app/data   # named volume (recommended)
Never run Nexterm without a persistent volume. Container restarts will wipe your entries, identities, and settings if /app/data is not mounted.

​
Next steps

Full installation guide

Step-by-step setup including Docker Compose examples, IPv6 support, and first-login instructions.

Environment variables

All supported environment variables with defaults and descriptions.

Reverse proxy setup

Configure Nginx, Caddy, Traefik, or Cloudflare Tunnel in front of Nexterm.

Upgrade Nexterm

How to pull the latest image and recreate containers safely.

Build docs developers (and LLMs) love

Get started for freeTalk to us