Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Matrix
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Container Registry
Model registry
Operate
Environments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TeDomum
Matrix
Commits
d8680c96
Commit
d8680c96
authored
7 years ago
by
kaiyou
Browse files
Options
Downloads
Patches
Plain Diff
Make it clear that the image has two modes of operation
parent
b9b668e4
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
contrib/docker/README.md
+24
-5
24 additions, 5 deletions
contrib/docker/README.md
with
24 additions
and
5 deletions
contrib/docker/README.md
+
24
−
5
View file @
d8680c96
...
...
@@ -21,23 +21,42 @@ You may have a local Python wheel cache available, in which case copy the releva
## Run
This image is designed to run either with an automatically generated configuration
file or with a custom configuration that requires manual edition.
### Automated configuration
It is recommended that you use Docker Compose to run your containers, including
this image and a Postgres server. A sample
``docker-compose.yml``
is provided,
including example labels for reverse proxying and other artifacts.
Then, to run the server:
Read the section about environment variables and set at least mandatory variables,
then run the server:
```
docker-compose up -d
```
In the case you specify a custom path for you configuration file and wish to
generate a fresh
``homeserver.yaml``
, simply run:
### Manual configuration
A sample
``docker-compose.yml``
is provided, including example labels for
reverse proxying and other artifacts.
Specify a
``SYNAPSE_CONFIG_PATH``
, preferably to a persistent path,
to use manual configuration. To generate a fresh
``homeserver.yaml``
, simply run:
```
docker-compose run --rm -e SYNAPSE_SERVER_NAME=my.matrix.host synapse generate
```
Then, customize your configuration and run the server:
```
docker-compose up -d
```
### Without Compose
If you do not wish to use Compose, you may still run this image using plain
Docker commands. Note that the following is just a guideline and you may need
to add parameters to the docker run command to account for the network situation
...
...
@@ -49,10 +68,10 @@ docker run \
--name synapse \
-v ${DATA_PATH}:/data \
-e SYNAPSE_SERVER_NAME=my.matrix.host \
matrixdotorg/synapse:latest
-e SYNAPSE_REPORT_STATS=yes \
docker.io/matrixdotorg/synapse:latest
```
## Volumes
The image expects a single volume, located at
``/data``
, that will hold:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment