Docs

Everything needed to run SecureTerm.

A practical guide for local development, production deployment, gateway configuration, and everyday team SSH workflows.

Local setup

Install dependencies, create the SQLite database, generate Prisma Client, and run the web app plus SSH gateway locally.

Server inventory

Add SSH targets with encrypted password or private-key credentials, tags, environments, and active-state controls.

Access control

Invite users, assign direct server access, or share server groups with members and admins.

Terminal and SFTP

Launch browser terminals and dual-pane SFTP sessions through the long-running Node gateway.

01

Configure environment

Set DATABASE_URL, JWT_SECRET, ENCRYPTION_KEY, NEXT_PUBLIC_APP_URL, gateway URL, and SMTP variables when invite emails are enabled.

02

Run database setup

Generate Prisma Client, initialize SQLite for the MVP, then migrate to PostgreSQL later without changing the product workflow.

03

Deploy separately

Deploy the Next.js web app and keep SSH/WebSocket traffic inside the long-running gateway service.

Start with the README, then use the app.

The repository includes deployment scripts, GitHub Actions, local SQLite setup, password recovery utilities, and Termius import tooling.

Open SecureTerm