v/tmate-ssh-server
1
0
Fork 0
mirror of https://github.com/tmate-io/tmate-ssh-server.git synced 2020-11-18 19:53:51 -08:00
Code Issues Releases Wiki Activity

Add readme for the docker image

Browse Source
This commit is contained in:
Nicolas Viennot 2019-10-13 04:59:38 -04:00
parent eb08daec79
commit fde93450dc
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -8,6 +8,25 @@ Usage
See on [tmate.io](http://tmate.io/).
Docker image
-----------
A docker image is provided:
[`tmate/tmate-ssh-server`](https://hub.docker.com/r/tmate/tmate-ssh-server)
The following environment variables are used to configure the server:
* `SSH_KEYS_PATH` (mandatory): The path where the ssh keys are located.
* `HAS_WEBSOCKET`: set to `1` if the tmate-websocket server exists (for HTML5
clients).
* `USE_PROXY_PROTOCOL`: set to `1` if the ssh server is behind a load balancer
that uses the [proxy protocol](http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) enabled.
This is useful to get client real IPs.
* `SSH_HOSTNAME`: configures the SSH hostname to advertise to tmate hosts.
* `SSH_PORT_LISTEN`: port on which the SSH server should listen on.
* `SSH_PORT_ADVERTISE`: configures the SSH port to advertise to tmate hosts.
Defaults to `SSH_PORT_LISTEN`.
License
--------

3
docker-entrypoint.sh
View File

@ -15,5 +15,6 @@ fi
SSH_PORT_LISTEN=${SSH_PORT_LISTEN:-2200}
SSH_PORT_ADVERTIZE=${SSH_PORT_ADVERTIZE:-${SSH_PORT_LISTEN}}
SSH_PORT_ADVERTISE=${SSH_PORT_ADVERTISE:-${SSH_PORT_ADVERTIZE}}
exec tmate-ssh-server -p ${SSH_PORT_LISTEN} -q ${SSH_PORT_ADVERTIZE} -k ${SSH_KEYS_PATH} "$@"
exec tmate-ssh-server -p ${SSH_PORT_LISTEN} -q ${SSH_PORT_ADVERTISE} -k ${SSH_KEYS_PATH} "$@"