pub/charts
1
0
Fork 0
Code Issues Pull requests Releases Packages 19 Activity Actions

matrix-synapse: Fix helm examples in readme

Browse source
This commit is contained in:
Alexander "Ace" Olofsson 2021-04-25 11:10:18 +02:00
parent 9473ba0dbd
commit aecf123352
No known key found for this signature in database
GPG key ID: D439C9470CB04C73
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
charts/matrix-synapse/README.md
View file

@ -30,13 +30,13 @@ Refer to [the main Synapse docs](https://github.com/matrix-org/synapse/blob/mast
For the simplest possible Matrix install, you can run your Synapse install on the root of the domain you wish in your MXIDs.
If you - for instance - own the domain `chosenin.space` and want to run Matrix on it, you would simply install the chart as;
helm install matrix-synapse --set serverName=chosenin.space --set wellknown.enabled=true
helm install matrix-synapse ananace/matrix-synapse --set serverName=chosenin.space --set wellknown.enabled=true
This would set up Synapse with client-server and federation both exposed on `chosenin.space/_matrix`, as well as a tiny lighttpd server that responds to federation lookups on `chosenin.space/.well-known/matrix/server`.
You can also use this to run a Synapse on a subdomain, with said subdomain as part of your MXIDs; (`@user:matrix.chosenin.space` in this case)
helm install matrix-synapse --set serverName=matrix.chosenin.space --set wellknown.enabled=true
helm install matrix-synapse ananace/matrix-synapse --set serverName=matrix.chosenin.space --set wellknown.enabled=true
### On separate subdomain
@ -44,7 +44,7 @@ If - on the other hand - you own the domain `example.com`, want your MXIDs in th
For DNS, you could install the chart as;
helm install matrix-synapse --set serverName=example.com --set publicServerName=matrix.example.com
helm install matrix-synapse ananace/matrix-synapse --set serverName=example.com --set publicServerName=matrix.example.com
This will add federation endpoints to `example.com`, along with client endpoints on `matrix.example.com`. For this to work, you will need to have valid certs for both `example.com` as well as `matrix.example.com` for your Synapse to use.
To get federation working with such a setup, you would also need to add an SRV record to your DNS - for example;
@ -53,7 +53,7 @@ To get federation working with such a setup, you would also need to add an SRV r
If you want to use a well-known file for federation instead of an SRV record, then your install might look more like;
helm install matrix-synapse --set serverName=example.com --set publicServerName=matrix.example.com --set wellknown.enabled=true
helm install matrix-synapse ananace/matrix-synapse --set serverName=example.com --set publicServerName=matrix.example.com --set wellknown.enabled=true
With well-known federation, your client-to-server/public host is the one that needs to handle both client and federation traffic. On your main domain you'll instead only need something that can respond with a JSON file on the URL `example.com/.well-known/matrix/server` - which the included wellknown server will gladly do for you.
Additionally, when using well-known federation, your Synapse cert only needs to be valid for `matrix.example.com`.