From 7134242084a35c0f8d54c4787b06181bfac963e8 Mon Sep 17 00:00:00 2001 From: Steve Smith Date: Thu, 15 Aug 2019 09:22:52 +1000 Subject: [PATCH] DCD-545: README formatting cleanup. --- README.md | 79 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 8e01fb7..7cf36bb 100644 --- a/README.md +++ b/README.md @@ -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: @@ -8,13 +13,14 @@ You can find the repository for this Dockerfile at 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. -We recommend 2GiB of memory allocated to accommodate the application server. -See [Supported Platforms](https://confluence.atlassian.com/display/DOC/Supported+platforms) for further information. +Please ensure your container has the necessary resources allocated to it. We +recommend 2GiB of memory allocated to accommodate the application server. See +[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._ ## 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) @@ -97,7 +105,8 @@ see https://tomcat.apache.org/tomcat-7.0-doc/config/index.html. ## 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` @@ -161,18 +170,15 @@ optional. ## Data Center configuration -This docker image can be run as part of a -[Data Center](https://confluence.atlassian.com/doc/confluence-data-center-technical-overview-790795847.html) -cluster. You can specify the following properties to start Confluence as a Data Center -node, instead of manually configuring a cluster. See -[Installing Confluence Data Center](https://confluence.atlassian.com/doc/installing-confluence-data-center-203603.html) -for more information. +This docker image can be run as part of a [Data Center][5] cluster. You can +specify the following properties to start Confluence as a Data Center node, +instead of manually configuring a cluster. See [Installing Confluence Data +Center][6] for more information. ### Cluster configuration Confluence Data Center allows clustering via various methods. For more -information on the setting for each type see -[this page](https://confluence.atlassian.com/doc/change-node-discovery-from-multicast-to-tcp-ip-or-aws-792297728.html#ChangeNodeDiscoveryfromMulticasttoTCP/IPorAWS-TochangefromTCP/IPtomulticast). +information on the setting for each type see [this page][7]. #### Common cluster settings @@ -227,12 +233,12 @@ of options available: * The Docker image can be rebuilt with a different UID. * Under Linux, the UID can be remapped using - [user namespace remapping](https://docs.docker.com/engine/security/userns-remap/). + [user namespace remapping][8]. # Upgrade -To upgrade to a more recent version of Confluence Server you can simply stop the `Confluence` -container and start a new one based on a more recent image: +To upgrade to a more recent version of Confluence Server you can simply stop the +`Confluence` container and start a new one based on a more recent image: $> docker stop 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 (`/data/your-confluence-home` in the example above). -Confluence's [automatic backup](https://confluence.atlassian.com/display/DOC/Configuring+Backups) is -currently supported in the Docker setup. You can also use the [Production Backup -Strategy](https://confluence.atlassian.com/display/DOC/Production+Backup+Strategy) -approach if you're using an external database. +Confluence's [automatic backup][9] is currently supported in the Docker +setup. You can also use the [Production Backup Strategy][10] 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 @@ -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 in deploying with containers will would be interesting in hearing your feedback. -Note that these images are built on the -[AdoptOpenJDK](https://adoptopenjdk.net/) images. Prior to Confluence 6.13 -OpenJDK was not a supported platform. See [the 6.13 -release-notes](https://confluence.atlassian.com/doc/confluence-6-13-release-notes-959288785.html) -for more information. +Note that these images are built on the [AdoptOpenJDK][12] images. Prior to +Confluence 6.13 OpenJDK was not a supported platform. See [the 6.13 +release-notes][13] 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