Documentation

Everything you need to run SSHManager

Deploy the API and web application, configure environment variables, and invite your team. For detailed setup instructions, read the project guide on GitHub.

Getting started

Invite your team, register servers, and launch SSH sessions directly from the browser. All requests go through the API at /api and require authentication.

API base URLs

The web application talks to the REST API exposed by the backend service. Keep NEXT_PUBLIC_API_URL and NEXT_PUBLIC_WS_URL aligned with your deployment hostname so the dashboard can reach the API and WebSocket gateway.

Magic link authentication

Email sign-in links are generated from APP_BASE_URL. Ensure this environment variable points to your public domain (for example https://ssh.realkia.com) so the link opens the hosted site instead of localhost.

Server access & auditing

SSH sessions stream through secure WebSockets. Each command is logged in the audit trail, and IP allowlists, rate limits, and encrypted credentials keep infrastructure secure.

Useful links