🔐 WebSSH

1. Open your browser and go to http://localhost:8080
2. Login with username and password (default: admin/admin)
3. Create a connection by clicking "+ New Connection" and entering SSH server details
4. Connect by clicking on the created connection
5. Open terminal and start working with the remote server
6. Use SFTP for file operations by clicking the "Files" tab

All SSH sessions are automatically recorded in asciinema format. To view recordings:

1. Click "Recordings" button in the left sidebar
2. Browse the list of recorded sessions (shows connection name, date, and duration)
3. Click ▶ Play to replay the recording in the embedded player
4. Download the recording as .cast.gz file for local storage
5. Delete old recordings to free up space

Recordings are kept for a configurable period (default 30 days) and automatically deleted after that.

MAX_UPLOAD_SIZE: Maximum file size (supports formats):

• "50M" - 50 megabytes
• "100M" - 100 megabytes
• "1G" - 1 gigabyte
• "500K" - 500 kilobytes

WEBSSH_USERS: Optional one-time import in format username:password,username2:password2. The first imported user becomes an administrator, the rest have the user role, and all imported users must change their password at first login. Remove this variable after the import.

On a fresh installation without imported users, use the first-start form to create the administrator. New passwords must contain at least 12 characters.

Administrators can create and delete accounts using Manage Users. New accounts must change their temporary password at first login.

JWT_SECRET: Secret key for JWT tokens (auto-generated if not set)

RECORDING_ENABLED: Enable/disable session recording (true or false)

RECORDING_RETENTION_DAYS: Number of days to keep recordings (default: 30)

📡 Installation Telemetry

Starting with version 0.5.0, WebSSH collects limited installation telemetry to understand active installations and deployed versions.

The telemetry contains only a randomly generated installation ID, WebSSH version, operating system, operating system version, CPU architecture, and Python runtime information.

Telemetry is enabled by default. To disable it, set the following environment variable:

STRIX_TELEMETRY_ENABLED=false

WebSSH does not send hostnames, usernames, IP addresses, SSH credentials, private keys, commands, terminal contents, or filesystem data.

🔒 Auto-Lock & Auto-Disconnect

WebSSH can automatically lock sessions after a period of inactivity and require your WebSSH password to unlock. Sessions can also be automatically disconnected after a longer period.

• Lock after: Period of inactivity before locking (5, 15, 30, 60 minutes)
• Disconnect after: Period of inactivity before disconnecting (30, 60 minutes, or never)
• Configuration: Set per connection in the connection settings
• Security: Lock requires WebSSH password only (not SSH password)

Encryption: All passwords and SSH keys are encrypted with AES-128 (Fernet).

JWT Tokens: Sessions are managed with JWT tokens with configurable timeout.

Docker Isolation: The application runs in an isolated Docker environment.

HTTPS: Recommended to use HTTPS in production environment.