Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Fix multiple typos
Browse files Browse the repository at this point in the history
  • Loading branch information
kaiyou committed Feb 4, 2018
1 parent b8ab78b commit f72c9c1
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 10 deletions.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ recursive-include synapse/static *.js
exclude jenkins.sh
exclude jenkins*.sh
exclude jenkins*
exclude Dockerfile
recursive-exclude jenkins *.sh

prune .github
Expand Down
19 changes: 12 additions & 7 deletions contrib/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You may have a local Python wheel cache available, in which case copy the releva

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,
with example labels for a reverse proxy and other artifacts.
including example labels for reverse proxying and other artifacts.

Then, to run the server:

Expand All @@ -35,13 +35,13 @@ In the case you specified a custom path for you configuration file and wish to
generate a fresh ``homeserver.yaml``, simply run:

```
docker-compose run synapse generate
docker-compose run --rm synapse generate
```

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 with your postgres database.
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
with your postgres database.

```
docker run \
Expand All @@ -55,18 +55,23 @@ docker run \

## Volumes

The image expects a single volue, located at ``/data``, that will hold:
The image expects a single volume, located at ``/data``, that will hold:

* temporary files during uploads;
* uploaded media and thumbnais;
* the SQLite database if you do not configure postgres.

## Environment

If you do not specify a custom path for the configuration file, a very generic
Unless you specify a custom path for the configuration file, a very generic
file will be generated, based on the following environment settings.
These are a good starting point for setting up your own deployment.

Global settings:

* ``UID``, the user id Synapse will run as [default 991]
* ``GID``, the group id Synapse will run as [default 991]

Synapse specific settings:

* ``SYNAPSE_SERVER_NAME`` (mandatory), the current server public hostname.
Expand Down
7 changes: 4 additions & 3 deletions contrib/docker/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This compose file is compatible with Copose itself, it might need some
# This compose file is compatible with Compose itself, it might need some
# adjustments to run properly with stack.

version: '3'
Expand All @@ -18,10 +18,11 @@ services:
- ./files:/data
depends_on:
- db
# One may either expose ports directly
# In order to expose Synapse, remove one of the following, you might for
# instance expose the TLS port directly:
ports:
- 8448:8448/tcp
# ... or use a reverse proxy, here is an example for traefik
# ... or use a reverse proxy, here is an example for traefik:
labels:
- traefik.enable=true
- traefik.frontend.rule=Host:my.matrix.Host
Expand Down

0 comments on commit f72c9c1

Please sign in to comment.