An official website of the United States government US flag signifying that this is a United States Federal Government website

Using SSH

Using SSH

You can use SSH to inspect how your app is operating, transfer files via SCP, or interact directly with your bound services. More information about one-off tasks.

You can get a shell via the cf ssh command, which lets you securely log in to an application instance where you can perform debugging, environment inspection, and other tasks.

Your application environment is not completely setup when you log in. You’ll probably need to configure your session to match your application’s environment in order to debug your application.

You can interact directly with the services bound to your application via port-forwarding. This allows you to access those services using native clients on your local machine. The Service Connect plugin makes this even easier.

Error messages

  • cf ssh uses port 2222. If your network blocks port 2222, you may receive an error message such as Error opening SSH connection.
  • Running python within an SSH session results in ImportError: No module named site.
    • To resolve this, configure your SSH session environment with these commands: for f in /home/vcap/app/.profile.d/*.sh; do source "$f"; done export LD_LIBRARY_PATH=/home/vcap/deps/0/python/lib/ export PYTHONHOME=/home/vcap/deps/0/python

How to disable SSH access

SSH access is enabled by default. Space Developers can disable SSH access to individual applications, and Space Managers can disable SSH access to all apps running within a space. See Enabling and Disabling SSH Access for the commands.

SSH version information

The application containers use the SSH-2.0 protocol. The SSH service uses the CloudFoundry SSH implementation. For more on how Cloud Foundry implements SSH, refer to Cloud Foundry’s documentation on Understanding Application SSH.