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.
1. Set the master password
If the server is on your own computer, a master password is required to store records. The app asks for it when you add the first record; on the command line:
quickssh vault set
Your records are encrypted with this password. The app asks for it on every start and whenever it locks.
2. Add a VPN profile
In the interface: New → New VPN profile. Choose the type, enter the connection details and press Create. On the command line:
quickssh add acme --kind fortigate --host vpn.acme.com -u alice
quickssh add depot --kind wireguard --config-file ~/depot.conf
If you don't save the password, it is asked on every start.
3. Start the VPN
Press the play icon next to the VPN in the list, or Start on its page.
quickssh up acme
quickssh ls
If the gateway's certificate is not recognized, the app shows its fingerprint and asks whether you trust it.
4. Add a session
Pick the type from the New menu (SSH, SFTP, FTP, RDP, VNC or a database). Enter the target; in the Route card, click the box in the middle and choose the VPN.
quickssh add-ssh web --host 10.20.0.15 -u deploy --vpn acme --ask-password
5. Connect
Double-click the session in the list or press Connect. If the VPN on its route is down, it is started first.
quickssh connect web
What's next
- Routes, keys and the file panel: Sessions
- Sending DataGrip or a browser through the VPN: VPN profiles
- Reaching a database without a tunnel: Databases
- Grouping records: open a record and type the group in the Organize card; or
quickssh group set Acme web db.