quickssh

quickssh wiki

From installation to daily use, from the central server to the command line: everything about quickssh.

Overview

quickssh lets you reach the systems behind your VPNs from a single app: servers, remote desktops, files and databases. Every VPN runs in its own isolated container; your computer's network is left alone.

Installation

You can install quickssh on your own computer, as a single container or as a central server for your team. Whichever you choose, the main requirement is Docker.

Getting started

After installation, adding your first VPN and your first session takes a few minutes. Every step can be done both in the interface and on the command line.

VPN profiles

Every VPN profile runs in its own container when started. Your computer's routing and DNS don't change; only the connections you open through quickssh enter the VPN.

Sessions

A session is a target to connect to. Depending on its type it opens as a terminal, a file manager or a remote desktop. For database records see Databases.

Databases

For PostgreSQL, MySQL, MSSQL and Redis records the server opens a port. Your tools connect to that port as if they were talking to the database directly; quickssh sets up the VPN and the tunnel.

Split tunneling

With split tunneling only the applications you choose go through the VPN; the rest of the computer stays on its own network.

Security

quickssh was designed to keep access credentials from spreading and from being used without permission. This page explains what is stored where and how it is protected.

Central server

On a central server, records and passwords live in one place; team members connect with their own clients. It is managed with the quicksshd commands on the server and the web panel.

Command line

Everything the interface does, the command line does too. In a Linux session without a display, quickssh without arguments doesn't try to open the interface and lists the commands instead.

Troubleshooting

Common situations and how to solve them.

Browser extension

With the extension you can say "open this site through that VPN / that server" while browsing. It exists for Chrome (Edge, Brave) and Firefox.

License

quickssh works without a license as well; a license only raises the number of records and users you can define.

Notes

Keep short notes like sticky notes and attach documents and files to them. A note can be attached to three places: