Skip to content

Container Installation

Single container with tmux-api (PWA + proxy) + ttyd + tmux.

  1. Run deploy command

    Terminal window
    ./scripts/termote.sh install container
  2. Access at http://localhost:7680

  3. (Optional) Expose to LAN

    Terminal window
    ./scripts/termote.sh install container --lan
Terminal window
# Basic (auto-generates credentials, check logs: docker logs termote)
docker run -d --name termote -p 7680:7680 ghcr.io/lamngockhuong/termote:latest
# With custom credentials
docker run -d --name termote -p 7680:7680 \
-e TERMOTE_USER=admin -e TERMOTE_PASS=secret \
ghcr.io/lamngockhuong/termote:latest
# Without auth (local dev only)
docker run -d --name termote -p 7680:7680 \
-e NO_AUTH=true \
ghcr.io/lamngockhuong/termote:latest
# With persistence
docker run -d --name termote -p 7680:7680 \
-v termote-data:/home/termote \
ghcr.io/lamngockhuong/termote:latest
FlagDescription
--lanExpose to LAN (default: localhost)
--no-authDisable basic auth
--port <port>Custom port (default: 7680)
Terminal window
./scripts/termote.sh health # Health check
docker ps -a | grep termote # Check container status
Terminal window
docker logs termote # View logs
docker logs -f termote # Follow logs (live)
# Or with podman:
podman logs termote
Terminal window
# Check startup errors
docker logs termote
# Port already in use?
lsof -i :7680
# Use different port
./scripts/termote.sh install container --port 7690
Terminal window
docker exec -it termote /bin/sh
# Inside container:
ps aux # Check processes
curl localhost:7681 # Test ttyd
curl localhost:7680/api/tmux/health
IssueSolution
Port in uselsof -i :7680 then kill or use --port
Container crashdocker logs termote to see error
Auth not workingRestart container, check logs for password
WebSocket errorCheck ttyd running inside container
Terminal window
docker restart termote
# Full reset
./scripts/termote.sh uninstall container
./scripts/termote.sh install container
Terminal window
curl http://localhost:7680/api/tmux/health
curl -u admin:password http://localhost:7680/api/tmux/sessions

Re-run the installer - it compares versions and prompts before updating:

Terminal window
curl -fsSL https://raw.githubusercontent.com/lamngockhuong/termote/main/scripts/get.sh | bash -s -- --container

Options:

  • --yes - Auto-update without prompt
  • --download-only - Download only, no install
Terminal window
./scripts/termote.sh uninstall container
git pull origin main
./scripts/termote.sh install container
Terminal window
./scripts/termote.sh uninstall container