SSH Access
Private Bench Groups allow you to securely access your bench using SSH. With SSH access, you can run Bench commands, inspect logs, troubleshoot issues, and perform maintenance tasks directly from the terminal.
SSH access is available only for Private Bench Groups. Before connecting, you must add your SSH public key to your Frappe Cloud account and generate a temporary SSH certificate. Each certificate remains valid for 6 hours.
Add Your SSH Key
- Open Settings in your Frappe Cloud dashboard.
- Scroll to the SSH Keys section.
- Click Add SSH Key.
- Paste your SSH public key and save it.
Copy the contents of your public key file (for example, ~/.ssh/id_rsa.pub) exactly as generated. Using command-line copy commands helps avoid formatting errors.
Generate an SSH Certificate
- Open your Bench Group dashboard.
- Click the three-dot (⋮) menu.
- Select SSH Access.
- Click Generate SSH Certificate.
- Follow the displayed commands to install the certificate on your local machine.
- Run the provided
sshcommand to connect to your bench.
What You Can Do
- Run Bench commands such as
bench restartandbench build. - Inspect application and worker logs.
- Debug custom applications.
- Perform maintenance and troubleshooting tasks.
Generate a new SSH certificate whenever the previous one expires. If SSH authentication fails, first verify that the uploaded public key matches the private key on your local machine before troubleshooting further.
