[ matjrix-docker-compose] create README.md for Task#11983

This commit is contained in:
kjg 2023-09-01 14:51:25 +00:00
parent 94902f34e5
commit 8e972990cf

33
README.md Normal file
View file

@ -0,0 +1,33 @@
## Usage and Components
Note: as of 2023-09-01 this docker-compose is available internally.
### Versions
* Element: https://hub.docker.com/r/vectorim/element-web/tags
* Synapse: https://hub.docker.com/r/matrixdotorg/synapse/tags
### Domains / homeserver.yaml and element-config.json
* synapseFQDN: on which domain the home server is reachable
* elementWebFQDN: on which domain element web will be deployed
* homeServerFQDN: the "matrix domain" that identifies the users
### Sample usage
Setting up matrix for ...
- the matrix domain "fn.nf"
- the homeserver "homeserver.fn.nf"
- element web on m.fn.nf
- set directory owner
```
chmod 777 ./synape
```
```
docker-compose up -d
```