Mirrored_Repos/docker-atlassian-confluence-server
1
0
Fork 0
mirror of https://bitbucket.org/atlassian-docker/docker-atlassian-confluence-server.git synced 2024-08-30 18:22:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

DCD-545: README formatting cleanup.

Browse Source
This commit is contained in:
Steve Smith 2019-08-15 09:22:52 +10:00
parent 7ef33622a8
commit 7134242084
1 changed files with 48 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
README.md
View File

@ -1,6 +1,11 @@
![Atlassian Confluence Server](https://www.atlassian.com/dam/wac/legacy/confluence_logo_landing.png) [Atlassian Confluence Server][1]
Confluence Server is where you create, organise and discuss work with your team. Capture the knowledge that's too often lost in email inboxes and shared network drives in Confluence – where it's easy to find, use, and update. Give every team, project, or department its own space to create the things they need, whether it's meeting notes, product requirements, file lists, or project plans, you can get more done in Confluence. Confluence Server is where you create, organise and discuss work with your
team. Capture the knowledge that's too often lost in email inboxes and shared
network drives in Confluence – where it's easy to find, use, and update. Give
every team, project, or department its own space to create the things they need,
whether it's meeting notes, product requirements, file lists, or project plans,
you can get more done in Confluence.
Learn more about Confluence Server: <https://www.atlassian.com/software/confluence> Learn more about Confluence Server: <https://www.atlassian.com/software/confluence>
@ -8,13 +13,14 @@ You can find the repository for this Dockerfile at <https://hub.docker.com/r/atl
# Overview # Overview
This Docker container makes it easy to get an instance of Confluence up and running. This Docker container makes it easy to get an instance of Confluence up and
running.
# Quick Start # Quick Start
For the directory in the environmental variable `CONFLUENCE_HOME` that is used For the directory in the environmental variable `CONFLUENCE_HOME` that is used
to store Confluence data (amongst other things) we recommend mounting a host to store Confluence data (amongst other things) we recommend mounting a host
directory as a [data volume](https://docs.docker.com/userguide/dockervolumes/#mount-a-host-directory-as-a-data-volume): directory as a [data volume][2]:
Additionally, if running Confluence in Data Center mode it is required that a Additionally, if running Confluence in Data Center mode it is required that a
shared filesystem is mounted. The mountpoint (inside the container) can be shared filesystem is mounted. The mountpoint (inside the container) can be
@ -25,18 +31,20 @@ Start Atlassian Confluence Server:
$> docker run -v /data/your-confluence-home:/var/atlassian/application-data/confluence --name="confluence" -d -p 8090:8090 -p 8091:8091 atlassian/confluence-server $> docker run -v /data/your-confluence-home:/var/atlassian/application-data/confluence --name="confluence" -d -p 8090:8090 -p 8091:8091 atlassian/confluence-server
**Success**. Confluence is now available on [http://localhost:8090](http://localhost:8090)* **Success**. Confluence is now available on [http://localhost:8090][3]*
Please ensure your container has the necessary resources allocated to it. Please ensure your container has the necessary resources allocated to it. We
We recommend 2GiB of memory allocated to accommodate the application server. recommend 2GiB of memory allocated to accommodate the application server. See
See [Supported Platforms](https://confluence.atlassian.com/display/DOC/Supported+platforms) for further information. [Supported Platforms][4] for further information.
_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8090` instead._ _* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8090` instead._
## Memory / Heap Size ## Memory / Heap Size
If you need to override Confluence Server's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. If you need to override Confluence Server's default memory allocation, you can
control the minimum heap (Xms) and maximum heap (Xmx) via the below environment
variables.
* `JVM_MINIMUM_MEMORY` (default: 1024m) * `JVM_MINIMUM_MEMORY` (default: 1024m)
@ -97,7 +105,8 @@ see https://tomcat.apache.org/tomcat-7.0-doc/config/index.html.
## JVM configuration ## JVM configuration
If you need to pass additional JVM arguments to Confluence such as specifying a custom trust store, you can add them via the below environment variable If you need to pass additional JVM arguments to Confluence such as specifying a
custom trust store, you can add them via the below environment variable
* `JVM_SUPPORT_RECOMMENDED_ARGS` * `JVM_SUPPORT_RECOMMENDED_ARGS`
@ -161,18 +170,15 @@ optional.
## Data Center configuration ## Data Center configuration
This docker image can be run as part of a This docker image can be run as part of a [Data Center][5] cluster. You can
[Data Center](https://confluence.atlassian.com/doc/confluence-data-center-technical-overview-790795847.html) specify the following properties to start Confluence as a Data Center node,
cluster. You can specify the following properties to start Confluence as a Data Center instead of manually configuring a cluster. See [Installing Confluence Data
node, instead of manually configuring a cluster. See Center][6] for more information.
[Installing Confluence Data Center](https://confluence.atlassian.com/doc/installing-confluence-data-center-203603.html)
for more information.
### Cluster configuration ### Cluster configuration
Confluence Data Center allows clustering via various methods. For more Confluence Data Center allows clustering via various methods. For more
information on the setting for each type see information on the setting for each type see [this page][7].
[this page](https://confluence.atlassian.com/doc/change-node-discovery-from-multicast-to-tcp-ip-or-aws-792297728.html#ChangeNodeDiscoveryfromMulticasttoTCP/IPorAWS-TochangefromTCP/IPtomulticast).
#### Common cluster settings #### Common cluster settings
@ -227,12 +233,12 @@ of options available:
* The Docker image can be rebuilt with a different UID. * The Docker image can be rebuilt with a different UID.
* Under Linux, the UID can be remapped using * Under Linux, the UID can be remapped using
[user namespace remapping](https://docs.docker.com/engine/security/userns-remap/). [user namespace remapping][8].
# Upgrade # Upgrade
To upgrade to a more recent version of Confluence Server you can simply stop the `Confluence` To upgrade to a more recent version of Confluence Server you can simply stop the
container and start a new one based on a more recent image: `Confluence` container and start a new one based on a more recent image:
$> docker stop confluence $> docker stop confluence
$> docker rm confluence $> docker rm confluence
@ -251,12 +257,11 @@ files in the Confluence Server home directory. In that case it is sufficient to
create a backup archive of the directory on the host that is used as a volume create a backup archive of the directory on the host that is used as a volume
(`/data/your-confluence-home` in the example above). (`/data/your-confluence-home` in the example above).
Confluence's [automatic backup](https://confluence.atlassian.com/display/DOC/Configuring+Backups) is Confluence's [automatic backup][9] is currently supported in the Docker
currently supported in the Docker setup. You can also use the [Production Backup setup. You can also use the [Production Backup Strategy][10] approach if you're
Strategy](https://confluence.atlassian.com/display/DOC/Production+Backup+Strategy) using an external database.
approach if you're using an external database.
Read more about data recovery and backups: [Site Backup and Restore](https://confluence.atlassian.com/display/DOC/Site+Backup+and+Restore) Read more about data recovery and backups: [Site Backup and Restore][11]
# Versioning # Versioning
@ -281,8 +286,20 @@ These Confluence Docker images are presented as a technical preview, and not
recommended for critical production deployments. However if you are interested recommended for critical production deployments. However if you are interested
in deploying with containers will would be interesting in hearing your feedback. in deploying with containers will would be interesting in hearing your feedback.
Note that these images are built on the Note that these images are built on the [AdoptOpenJDK][12] images. Prior to
[AdoptOpenJDK](https://adoptopenjdk.net/) images. Prior to Confluence 6.13 Confluence 6.13 OpenJDK was not a supported platform. See [the 6.13
OpenJDK was not a supported platform. See [the 6.13 release-notes][13] for more information.
release-notes](https://confluence.atlassian.com/doc/confluence-6-13-release-notes-959288785.html)
for more information. [1]: https://www.atlassian.com/dam/wac/legacy/confluence_logo_landing.png
[2]: https://docs.docker.com/userguide/dockervolumes/#mount-a-host-directory-as-a-data-volume
[3]: http://localhost:8090
[4]: https://confluence.atlassian.com/display/DOC/Supported+platforms
[5]: https://confluence.atlassian.com/doc/confluence-data-center-technical-overview-790795847.html
[6]: https://confluence.atlassian.com/doc/installing-confluence-data-center-203603.html
[7]: https://confluence.atlassian.com/doc/change-node-discovery-from-multicast-to-tcp-ip-or-aws-792297728.html#ChangeNodeDiscoveryfromMulticasttoTCP/IPorAWS-TochangefromTCP/IPtomulticast
[8]: https://docs.docker.com/engine/security/userns-remap/
[9]: https://confluence.atlassian.com/display/DOC/Configuring+Backups
[10]: https://confluence.atlassian.com/display/DOC/Production+Backup+Strategy
[11]: https://confluence.atlassian.com/display/DOC/Site+Backup+and+Restore
[12]: https://adoptopenjdk.net/
[13]: https://confluence.atlassian.com/doc/confluence-6-13-release-notes-959288785.html