SSH on CodeRed Cloud#

Paid plans on CodeRed Cloud include limited SSH shell access. SCP is not available; to transfer files use SFTP instead.

The ssh command line tool is included in most Linux distributions, macOS, and even Windows 10. If you are having trouble using SSH on Windows, see enable SSH client in Windows 10.

Obtain Your SSH Server Info#

SSH credentials can be obtained through the CLI, or the dashboard.

To see your SSH credentials using the CLI, replace WEBAPP below with your website handle (see CodeRed Cloud CLI Quickstart).

$ cr ssh WEBAPP

Alternatively, your SSH server info can be obtained by clicking the Deployment tab of a website in the CodeRed Cloud dashboard, as in the image below.

To access the info for your staging site, toggle between Staging / Production in the top left corner.

Click Reset System Password to generate a temporary password. All passwords on CodeRed Cloud are temporary and may be reset when the site is deployed.

SSH info in dashboard

Connect Using the Command Line#

Open a command line and run ssh with your server info. You will be prompted for your password.

$ ssh -p 2222 demo@demo.codered.cloud
demo@demo.codered.cloud's password:

After entering the password, you will be logged in to your web server’s BASH shell.

When finished, type exit to disconnect from the server.

Limitations#

For maximum security and performance, the server is a bare-bones environment designed exclusively for running production-ready code:

  • Limited software: Your application platform (Python or PHP) is the only software installed. Common developer tools such as git, npm, curl, nano, vi etc. are intentionally omitted. The server is NOT a development environment.

  • Root and sudo are not available. It is not possible to install software or alter the system in any way.

  • The system is ephemeral, meaning the entire system is re-built every time your app is deployed. Any changes you make over SSH outside of the www directory will not be preserved.

  • Do not make virtualenvs or install pip packages. Python-based systems are pre-configured with packages from your requirements.txt file. Any pip packages you install or modify over SSH will be eliminated when your app is re-deployed.

  • Never edit code using SSH. Code should be edited and tested in your local development environment, then deployed as normal.

Warning

SSH should be used sparingly. One mistake could take down your website, or cause unexpected breakage. SSH should only be used for running one-off Django management commands or WordPress CLI commands which have been first tested in your local development environment.