-
Notifications
You must be signed in to change notification settings - Fork 7
/
README.old
142 lines (83 loc) · 5.01 KB
/
README.old
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
This README is still WIP
---
docker-confluence-for-testing
Docker image to run Atlassian Confluence using an Oracle JRE
# Overview
This Docker container makes it easy to get an instance of Confluence up and running.
# Main Usage
```bash
./scripts/run-confluence-container.sh [x.y.z]
```
x.y.z is an optional parameter with the Confluence version number you want to run.
Otherwise the default version that appears on the .env file will be used.
Confluence instance will be listening on http://localhost:8090/confluence
## Additional settings
```
./scripts/run-confluence-container.sh [x.y.z] [ENV=VALUE ENV2=VALUE]
```
### Debugging port
```
DEBUG_PORT=5006
```
### Change container localization and timezone
```
TZ=America/Los_Angeles
LC_ALL=en_US.UTF-8
LANG=en_US.UTF-8
LANGUAGE=en_US.UTF-8
```
--------
--------
### From here the documentation needs to be updated to reflect some of the changes made
# Quick Start
For the directory in the environmental variable `CONFLUENCE_HOME` that is used 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):
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
**Success**. Confluence is now available on [http://localhost:8090](http://localhost:8090)*
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.
_* 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.
* `JVM_MINIMUM_MEMORY` (default: 1024m)
The minimum heap size of the JVM
* `JVM_MAXIMUM_MEMORY` (default: 1024m)
The maximum heap size of the JVM
## Reverse Proxy Settings
If Confluence is run behind a reverse proxy server, then you need to specify extra options to make Confluence aware of the setup. They can be controlled via the below environment variables.
* `CATALINA_CONNECTOR_PROXYNAME` (default: NONE)
The reverse proxy's fully qualified hostname.
* `CATALINA_CONNECTOR_PROXYPORT` (default: NONE)
The reverse proxy's port number via which Confluence is accessed.
* `CATALINA_CONNECTOR_SCHEME` (default: http)
The protocol via which Confluence is accessed.
* `CATALINA_CONNECTOR_SECURE` (default: false)
Set 'true' if CATALINA_CONNECTOR_SCHEME is 'https'.
## 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
* `JVM_SUPPORT_RECOMMENDED_ARGS`
Additional JVM arguments for Confluence
Example:
$> docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/confluence/cacerts -v confluenceVolume:/var/atlassian/application-data/confluence --name="confluence" -d -p 8090:8090 -p 8091:8091 atlassian/confluence-server
# 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:
$> docker stop confluence
$> docker rm confluence
$> docker run ... (see above)
As your data is stored in the data volume directory on the host, it will still
be available after the upgrade.
_Note: Please make sure that you **don't** accidentally remove the `confluence`
container and its volumes using the `-v` option._
# Backup
For evaluating Confluence you can use the built-in database that will store its 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.
Read more about data recovery and backups: [Site Backup and Restore](https://confluence.atlassian.com/display/DOC/Site+Backup+and+Restore)
# Versioning
The `latest` tag matches the most recent release of Atlassian Confluence Server.
So `atlassian/confluence-server:latest` will use the newest stable version of Confluence Server available.
Alternatively, you can use a specific minor version of Confluence Server by using a version number
tag: `atlassian/confluence-server:5.10`. This will install the latest `5.10.x` version that
is available.