Include x_forwarded in workers example configs (#14667)

This commit is contained in:
villepeh 2023-01-13 16:06:58 +02:00 committed by GitHub
parent 3a125625e7
commit d344bc8b6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 15 additions and 7 deletions

1
changelog.d/14667.doc Normal file
View File

@ -0,0 +1 @@
Include `x_forwarded` entry in the HTTP listener example configs and remove the remaining `worker_main_http_uri` entries.

View File

@ -15,19 +15,19 @@ worker_name: generic_worker$i
worker_replication_host: 127.0.0.1 worker_replication_host: 127.0.0.1
worker_replication_http_port: 9093 worker_replication_http_port: 9093
worker_main_http_uri: http://localhost:8008/
worker_listeners: worker_listeners:
- type: http - type: http
port: 808$i port: 808$i
x_forwarded: true
resources: resources:
- names: [client, federation] - names: [client, federation]
worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml
#worker_pid_file: DATADIR/generic_worker$i.pid
EOF EOF
done done
``` ```
This would create five generic workers with a unique `worker_name` field in each file and listening on ports 8081-8085. This would create five generic workers with a unique `worker_name` field in each file and listening on ports 8081-8085.
Customise the script to your needs. Customise the script to your needs. Note that `worker_pid_file` is required if `worker_daemonize` is `true`. Uncomment and/or modify the line if needed.

View File

@ -10,6 +10,8 @@ Remember to route necessary endpoints directly to a worker associated with it.
If you run the script as-is, it will create workers with the replication listener starting from port 8034 and another, regular http listener starting from 8044. If you don't need all of the stream writers listed in the script, just remove them from the ```STREAM_WRITERS``` array. If you run the script as-is, it will create workers with the replication listener starting from port 8034 and another, regular http listener starting from 8044. If you don't need all of the stream writers listed in the script, just remove them from the ```STREAM_WRITERS``` array.
Hint: Note that `worker_pid_file` is required if `worker_daemonize` is `true`. Uncomment and/or modify the line if needed.
```sh ```sh
#!/bin/bash #!/bin/bash
@ -46,9 +48,11 @@ worker_listeners:
- type: http - type: http
port: $(expr $HTTP_START_PORT + $i) port: $(expr $HTTP_START_PORT + $i)
x_forwarded: true
resources: resources:
- names: [client] - names: [client]
#worker_pid_file: DATADIR/${STREAM_WRITERS[$i]}.pid
worker_log_config: /etc/matrix-synapse/stream-writer-log.yaml worker_log_config: /etc/matrix-synapse/stream-writer-log.yaml
EOF EOF
HOMESERVER_YAML_INSTANCE_MAP+=$" ${STREAM_WRITERS[$i]}_stream_writer: HOMESERVER_YAML_INSTANCE_MAP+=$" ${STREAM_WRITERS[$i]}_stream_writer:
@ -91,7 +95,9 @@ Simply run the script to create YAML files in the current folder and print out t
```console ```console
$ ./create_stream_writers.sh $ ./create_stream_writers.sh
```
You should receive an output similar to the following:
```console
# Add these lines to your homeserver.yaml. # Add these lines to your homeserver.yaml.
# Don't forget to configure your reverse proxy and # Don't forget to configure your reverse proxy and
# necessary endpoints to their respective worker. # necessary endpoints to their respective worker.

View File

@ -17,6 +17,7 @@ worker_listeners:
# #
#- type: http #- type: http
# port: 8035 # port: 8035
# x_forwarded: true
# resources: # resources:
# - names: [client] # - names: [client]

View File

@ -5,11 +5,10 @@ worker_name: generic_worker1
worker_replication_host: 127.0.0.1 worker_replication_host: 127.0.0.1
worker_replication_http_port: 9093 worker_replication_http_port: 9093
worker_main_http_uri: http://localhost:8008/
worker_listeners: worker_listeners:
- type: http - type: http
port: 8083 port: 8083
x_forwarded: true
resources: resources:
- names: [client, federation] - names: [client, federation]

View File

@ -8,6 +8,7 @@ worker_replication_http_port: 9093
worker_listeners: worker_listeners:
- type: http - type: http
port: 8085 port: 8085
x_forwarded: true
resources: resources:
- names: [media] - names: [media]