[Other doc versions]
There are two scenarios where you might want to set up port forwarding.
Stash listens for SSH connections on port 7999 by default.
Your users will need to include the port in the URL they use to clone from Stash, for example:
git clone ssh://firstname.lastname@example.org:7999/PROJECT/repo.git
Rather than have the port number in the URL, you may wish to set up port forwarding so that connections to the default SSH port are forwarded to the port Stash is listening on (e.g. you could forward port 22 to port 7999).
This would allow your users to use a URL without a port number in it, like this:
git clone ssh://email@example.com/PROJECT/repo.git
You may be following our instructions for setting up Stash behind an Apache front-end.
In this case, your users may not be able to access Stash directly for SSH connections, or if they can, you may wish to make the SSH and HTTP/S URLs consistent.
For example, if you have the above topology, without port forwarding (and assuming the default port of 7999), your users will need to clone Stash directly from the backend, like this:
git clone ssh://firstname.lastname@example.org:7999/PROJECT/repo.git
In your network, the
stash.backend.atlassian.com machine may not be accessible directly, or you may want the URL to be consistent with the HTTP/S URL of
In this case, you need to set up port forwarding on the
stash.atlassian.com machine to accept connections and forward them to port 7999 on the
Atlassian recommends the use of HAProxy for forwarding SSH connections through to Stash.
HAProxy is supported on Linux, Solaris and FreeBSD.
Your Operating System may support installing HAProxy via it's system package manager, such as
rpm. This will be the easiest way.
Alternatively, you may build HAProxy yourself and install it.
Extract the archive and cd into the directory:
tar xzvf haproxy-1.4.21.tar.gz cd haproxy-1.4.21
Read the instructions in the README for how to build on your system. This is generally quite simple - on a Linux 64 bit 2.6 Kernel, the command is:
make TARGET=linux26 ARCH=x86_64
If it completes successfully, install it following the instructions in the README:
sudo make install
HAProxy is extremely powerful - it is designed as a http/s load balancer, but also can serve as a port forwarder for ssh.
The full documentation for version 1.4 is here. More documentation is available on the HAProxy web site.
An example simple configuration is as follows:
global daemon maxconn 10000 defaults timeout connect 500s timeout client 5000s timeout server 1h frontend sshd bind *:7999 default_backend ssh timeout client 1h backend ssh mode tcp server localhost-stash-ssh 127.0.0.1:7999 check port 7999
The above configuration will listen on port 7999 (indicated by the
bind directive) on all network interfaces. As indicated by the
server directive, traffic is forwarded to 127.0.0.1, port 7999. You will need to replace
127.0.0.1 with the IP address of the machine running Stash.
You can check your configuration by running:
haproxy -f haproxyconf.txt -c
To run haproxy, simply start it using
haproxy -f haproxyconf.txt
If you use HAProxy to additionally proxy HTTP traffic, ensure that the running
mode configuration is set to
backend http mode http bind *:80 server localhost-stash-http 127.0.0.1:7990
You can configure HAProxy to listen on the default SSH port instead, so that the port does not need to be specified in the clone URL.
By default, the normal ssh daemon is running on port 22. You have several options:
We do not provide instructions on the last two options, except for how to configure HAProxy.
Use the same configuration as the last example, but change the bind port to 22, e.g.
... frontend sshd bind *:22 ...
You will have to run this configuration as the
root user, using
sudo, because it specifies a port to listen on that is less than 1024.
sudo haproxy -f haproxyconf.txt
Once port forwarding is set up, you will need to configure the SSH base URL in Stash so that the clone urls presented in Stash indicate the correct host and port to clone from. See the SSH base URL section in Enabling SSH access to Git repositories in Stash.