Skip to content

Installing ContainerSSH

ContainerSSH is provided on the GitHub releases page. You can install it in a containerized environment or as a standalone software on Windows, Linux, and MacOS.

Running in a containerized environment

When running ContainerSSH in a containerized environment we recommend using the image containerssh/containerssh. You will also need to mount or provide the following files:

/etc/containerssh/config.yaml
This is the base configuration file. Parts of it can be modified by the configuration server call.
/var/secrets/ssh_host_rsa_key:
This is the default path for the host key. You can generate this host key using the OpenSSL tool: openssl genrsa > /var/secrets/ssh_host_rsa_key

When using the dockerrun backend, you can also mount /var/run/docker.sock into the container. Please note, in this case the Docker socket must be accessible by the user with the uid 1022. Alternatively, you can set up the Docker socket via TCP.

When using the kuberun backend you must provide credentials via the configuration file or the configserver

Running as a standalone application

ContainerSSH is supplied as a single binary that runs on all major platforms. After downloading the binary and creating the configuration file you can run ContainerSSH with the following command:

containerssh --config /path/to/your/configuration/file