https://github.com/handcraftedbits/docker-nginx-unit-confluence
A Docker container that provides an Atlassian Confluence unit for NGINX Host
https://github.com/handcraftedbits/docker-nginx-unit-confluence
Last synced: 2 days ago
JSON representation
A Docker container that provides an Atlassian Confluence unit for NGINX Host
- Host: GitHub
- URL: https://github.com/handcraftedbits/docker-nginx-unit-confluence
- Owner: handcraftedbits
- License: apache-2.0
- Created: 2016-07-21T23:48:27.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-21T02:03:36.000Z (over 9 years ago)
- Last Synced: 2025-12-13T03:56:27.060Z (7 months ago)
- Language: Shell
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NGINX Host Confluence Unit [](https://hub.docker.com/r/handcraftedbits/nginx-unit-confluence)
A [Docker](https://www.docker.com) container that provides an
[Atlassian Confluence](https://www.atlassian.com/software/confluence) unit for
[NGINX Host](https://github.com/handcraftedbits/docker-nginx-host).
# Features
* Atlassian Confluence 6.1.0
* NGINX Host SSL certificates are automatically imported into Confluence's JVM so Atlassian application links can
easily be created
# Support Notes
This container uses [OpenJDK](http://openjdk.java.net/) for its JVM and as such this unit is considered an **unsupported
platform** by Atlassian.
# Usage
## Prerequisites
### Database
Make sure you have a
[supported database](https://confluence.atlassian.com/doc/database-configuration-159764.html) available either as a
container or standalone.
### `NGINX_UNIT_HOSTS` Considerations
It is important that the value of your `NGINX_UNIT_HOSTS` environment variable is set to a single value and doesn't
include wildcards or regular expressions as this value will be used by Confluence to determine the hostname.
## Configuration
It is highly recommended that you use container orchestration software such as
[Docker Compose](https://www.docker.com/products/docker-compose) when using this NGINX Host unit as several Docker
containers are required for operation. This guide will assume that you are using Docker Compose. Additionally, we
will use the [official PostgreSQL Docker container](https://hub.docker.com/_/postgres/) for our database.
To begin, start with a basic `docker-compose.yml` file as described in the
[NGINX Host configuration guide](https://github.com/handcraftedbits/docker-nginx-host#configuration). Then, add a
service for the database (named `db-confluence`) and the NGINX Host Confluence unit (named `confluence`):
```yaml
confluence:
image: handcraftedbits/nginx-unit-confluence
environment:
- NGINX_UNIT_HOSTS=mysite.com
- NGINX_URL_PREFIX=/confluence
links:
- db-confluence
volumes:
- data:/opt/container/shared
- /home/me/confluence:/opt/data/confluence
db-confluence:
image: postgres
environment:
- POSTGRES_USER=user
- POSTGRES_PASSWORD=password
- POSTGRES_DB=confluence
volumes:
/home/me/db-confluence:/var/lib/postgresql/data
```
Observe the following:
* We create a link in `confluence` to `db-confluence` in order to allow Confluence to connect to our database.
* We mount `/opt/data/confluence` using the local directory `/home/me/confluence`. This is the directory where
Confluence stores its data.
* As with any other NGINX Host unit, we mount our data volume, in this case named `data`, to `/opt/container/shared`.
For more information on configuring the PostgreSQL container, consult its
[documentation](https://hub.docker.com/_/postgres/).
Finally, we need to create a link in our NGINX Host container to the `confluence` container in order to proxy
Confluence. Here is our final `docker-compose.yml` file:
```yaml
version: "2.1"
volumes:
data:
services:
confluence:
image: handcraftedbits/nginx-unit-confluence
environment:
- NGINX_UNIT_HOSTS=mysite.com
- NGINX_URL_PREFIX=/confluence
links:
- db-confluence
volumes:
- data:/opt/container/shared
- /home/me/confluence:/opt/data/confluence
db-confluence:
image: postgres
environment:
- POSTGRES_USER=user
- POSTGRES_PASSWORD=password
- POSTGRES_DB=confluence
volumes:
/home/me/db-confluence:/var/lib/postgresql/data
proxy:
image: handcraftedbits/nginx-host
links:
- confluence
ports:
- "443:443"
volumes:
- data:/opt/container/shared
- /etc/letsencrypt:/etc/letsencrypt
- /home/me/dhparam.pem:/etc/ssl/dhparam.pem
```
This will result in making a Confluence instance available at `https://mysite.com/confluence`.
## Running the NGINX Host Confluence Unit
Assuming you are using Docker Compose, simply run `docker-compose up` in the same directory as your
`docker-compose.yml` file. Otherwise, you will need to start each container with `docker run` or a suitable
alternative, making sure to add the appropriate environment variables and volume references.
When configuring Confluence, be sure to select `PostgreSQL` as your database, `db-confluence` as the database hostname,
and `5432` as the database port if you configured your database according to the previous section.
# Reference
## Environment Variables
Please see the NGINX Host [documentation](https://github.com/handcraftedbits/docker-nginx-host#units) for information
on the environment variables understood by this unit.