[Other doc versions]
[Doc downloads (PDF, HTML, XML)]
This page describes how to establish a network topology in which the nginx server acts as a reverse proxy for Stash. Typically, such a configuration would be used when Stash is installed in a protected zone 'behind the firewall', and nginx provides a gateway through which users outside the firewall can access Stash.
The configuration described on this page results in a scenario where:
Please note that:
Be aware that Stash does not need to run behind a web server, since it is capable of serving web requests directly; to secure Stash when run in this way see Securing Stash with Tomcat using SSL. Otherwise, if you want to install Stash in an environment that incorporates nginx, this document is for you. (You can of course run Stash behind nginx without securing client connections to nginx using SSL – we don't describe this option on this page.)
Note that the Atlassian Support Offering does not cover nginx integration. Assistance with nginx may be obtained through the Atlassian community from answers.atlassian.com or from an Atlassian Expert.
Find the normal (non-SSL)
Connector directive in Tomcat's
server.xml file, and add the
proxyName , and
proxyPort attributes as shown below. Instead of
mycompany.com, set the
proxyName attribute to your domain name that the nginx server will be configured to serve. This informs Stash of the domain name and port of the requests that reach it via nginx, and is important to the correct operation of the Stash functions that construct URLs.
For more information about configuring the Tomcat Connector, refer to the Apache Tomcat 7.0 HTTP Connector Reference.
By default, Stash is configured to run with an empty context path; in other words, from the 'root' of the server's name space. In that default configuration, Stash would be accessed at:
For the example configuration on this page, we want Stash to be accessed at:
server.xml file, set the context path to
If you use a context path, it is important that the same path is:
roxy_passdirective (Step 4).
After re-starting Stash, open a browser window and log into Stash using an administrator account. Go to the Stash administration area and click Server settings (under 'Settings'), and change Base URL to match the proxy URL (the URL that the nginx server will be serving).
For this example, use
(Note the context path with this.)
/etc/nginx/nginx.conf, using the example server configuration below, to configure nginx as a proxy server.
proxy_pass directive in the location block, and specify the protocol, name and port of the proxied server in the parameter (in our case, it is http://localhost:7990):
Changes made in the configuration file will not be applied until the command to reload configuration is sent to nginx or it is restarted. To reload the configuration, execute:
This command should be executed under the same user that started nginx.
You may find the following resources helpful in setting up Stash behind nginx: