Container Installation
Single container with tmux-api (PWA + proxy) + ttyd + tmux.
Quick Start
Section titled “Quick Start”-
Run deploy command
Terminal window ./scripts/termote.sh install container -
Access at http://localhost:7680
-
(Optional) Expose to LAN
Terminal window ./scripts/termote.sh install container --lan
Docker Run
Section titled “Docker Run”# Basic (auto-generates credentials, check logs: docker logs termote)docker run -d --name termote -p 7680:7680 ghcr.io/lamngockhuong/termote:latest
# With custom credentialsdocker 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 persistencedocker run -d --name termote -p 7680:7680 \ -v termote-data:/home/termote \ ghcr.io/lamngockhuong/termote:latestOptions
Section titled “Options”| Flag | Description |
|---|---|
--lan | Expose to LAN (default: localhost) |
--no-auth | Disable basic auth |
--port <port> | Custom port (default: 7680) |
Troubleshooting
Section titled “Troubleshooting”Quick Diagnostics
Section titled “Quick Diagnostics”./scripts/termote.sh health # Health checkdocker ps -a | grep termote # Check container statusView Logs
Section titled “View Logs”docker logs termote # View logsdocker logs -f termote # Follow logs (live)
# Or with podman:podman logs termoteContainer won’t start
Section titled “Container won’t start”# Check startup errorsdocker logs termote
# Port already in use?lsof -i :7680
# Use different port./scripts/termote.sh install container --port 7690Debug inside container
Section titled “Debug inside container”docker exec -it termote /bin/sh# Inside container:ps aux # Check processescurl localhost:7681 # Test ttydcurl localhost:7680/api/tmux/healthCommon Issues
Section titled “Common Issues”| Issue | Solution |
|---|---|
| Port in use | lsof -i :7680 then kill or use --port |
| Container crash | docker logs termote to see error |
| Auth not working | Restart container, check logs for password |
| WebSocket error | Check ttyd running inside container |
Restart / Reset
Section titled “Restart / Reset”docker restart termote
# Full reset./scripts/termote.sh uninstall container./scripts/termote.sh install containerAPI Test
Section titled “API Test”curl http://localhost:7680/api/tmux/healthcurl -u admin:password http://localhost:7680/api/tmux/sessionsUpdating
Section titled “Updating”Via One-liner
Section titled “Via One-liner”Re-run the installer - it compares versions and prompts before updating:
curl -fsSL https://raw.githubusercontent.com/lamngockhuong/termote/main/scripts/get.sh | bash -s -- --containerOptions:
--yes- Auto-update without prompt--download-only- Download only, no install
Manual Update
Section titled “Manual Update”./scripts/termote.sh uninstall containergit pull origin main./scripts/termote.sh install containerUninstall
Section titled “Uninstall”./scripts/termote.sh uninstall container