You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: contrib/workers-bash-scripts/create-multiple-stream-writers.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Creating multiple stream writers with a bash script
2
2
3
-
This script creates multiple [stream writer](https://github.com/matrix-org/synapse/blob/develop/docs/workers.md#stream-writers) workers.
3
+
This script creates multiple [stream writer](https://github.com/element-hq/synapse/blob/develop/docs/workers.md#stream-writers) workers.
4
4
5
5
Stream writers require both replication and HTTP listeners.
6
6
7
7
It also prints out the example lines for Synapse main configuration file.
8
8
9
9
Remember to route necessary endpoints directly to a worker associated with it.
10
10
11
-
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.
11
+
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.
12
12
13
13
Hint: Note that `worker_pid_file` is required if `worker_daemonize` is `true`. Uncomment and/or modify the line if needed.
14
14
@@ -71,7 +71,7 @@ cat << EXAMPLECONFIG
71
71
# Don't forget to configure your reverse proxy and
72
72
# necessary endpoints to their respective worker.
73
73
74
-
# See https://github.com/matrix-org/synapse/blob/develop/docs/workers.md
74
+
# See https://github.com/element-hq/synapse/blob/develop/docs/workers.md
75
75
# for more information.
76
76
77
77
# Remember: Under NO circumstances should the replication
@@ -102,7 +102,7 @@ You should receive an output similar to the following:
102
102
# Don't forget to configure your reverse proxy and
103
103
# necessary endpoints to their respective worker.
104
104
105
-
# See https://github.com/matrix-org/synapse/blob/develop/docs/workers.md
105
+
# See https://github.com/element-hq/synapse/blob/develop/docs/workers.md
106
106
# for more information
107
107
108
108
# Remember: Under NO circumstances should the replication
@@ -138,14 +138,14 @@ Simply copy-and-paste the output to an appropriate place in your Synapse main co
138
138
139
139
## Write directly to Synapse configuration file
140
140
141
-
You could also write the output directly to homeserver main configuration file. **This, however, is not recommended** as even a small typo (such as replacing >> with >) can erase the entire ```homeserver.yaml```.
141
+
You could also write the output directly to homeserver main configuration file. **This, however, is not recommended** as even a small typo (such as replacing >> with >) can erase the entire ```homeserver.yaml```.
142
142
143
143
If you do this, back up your original configuration file first:
Copy file name to clipboardexpand all lines: docker/README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ The following environment variables are supported in `generate` mode:
78
78
79
79
## Postgres
80
80
81
-
By default the config will use SQLite. See the [docs on using Postgres](https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md) for more info on how to use Postgres. Until this section is improved [this issue](https://github.com/matrix-org/synapse/issues/8304) may provide useful information.
81
+
By default the config will use SQLite. See the [docs on using Postgres](https://github.com/element-hq/synapse/blob/develop/docs/postgres.md) for more info on how to use Postgres. Until this section is improved [this issue](https://github.com/element-hq/synapse/issues/8304) may provide useful information.
82
82
83
83
## Running synapse
84
84
@@ -151,7 +151,7 @@ is suitable for local testing, but for any practical use, you will either need
151
151
to use a reverse proxy, or configure Synapse to expose an HTTPS port.
Generally speaking, streams are a series of notifications that something in Synapse's database has changed that the application might need to respond to.
7
7
For example:
@@ -11,12 +11,12 @@ For example:
11
11
- The to-device stream reports when a device has a new [to-device message](https://spec.matrix.org/v1.7/client-server-api/#send-to-device-messaging).
It is very helpful to understand the streams mechanism when working on any part of Synapse that needs to respond to changes—especially if those changes are made by different workers.
18
18
To that end, let's describe streams formally, paraphrasing from the docstring of [`AbstractStreamIdGenerator`](
For all other installation methods, no acction is required.
@@ -1068,7 +1068,7 @@ As announced with the release of [Synapse 1.47.0](#deprecation-of-the-user_may_c
1068
1068
the deprecated `user_may_create_room_with_invites` module callback has been removed.
1069
1069
1070
1070
Modules relying on it can instead implement [`user_may_invite`](https://matrix-org.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite)
1071
-
and use the [`get_room_state`](https://github.com/matrix-org/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
1071
+
and use the [`get_room_state`](https://github.com/element.-hq/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
1072
1072
module API to infer whether the invite is happening while creating a room (see [this function](https://github.com/matrix-org/synapse-domain-rule-checker/blob/e7d092dd9f2a7f844928771dbfd9fd24c2332e48/synapse_domain_rule_checker/__init__.py#L56-L89)
1073
1073
as an example). Alternately, modules can also implement [`on_create_room`](https://matrix-org.github.io/synapse/latest/modules/third_party_rules_callbacks.html#on_create_room).
1074
1074
@@ -1124,7 +1124,7 @@ Any scripts still using the above APIs should be converted to use the
1124
1124
The `user_may_create_room_with_invites` is deprecated and will be removed in a future
1125
1125
version of Synapse. Modules implementing this callback can instead implement
and use the [`get_room_state`](https://github.com/matrix-org/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
1127
+
and use the [`get_room_state`](https://github.com/element.-hq/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
1128
1128
module API method to infer whether the invite is happening in the context of creating a
1129
1129
room.
1130
1130
@@ -1171,8 +1171,8 @@ Any scripts still using the above APIs should be converted to use the
1171
1171
## User-interactive authentication fallback templates can now display errors
1172
1172
1173
1173
This may affect you if you make use of custom HTML templates for the
1174
-
[reCAPTCHA (`synapse/res/templates/recaptcha.html`)](https://github.com/matrix-org/synapse/tree/develop/synapse/res/templates/recaptcha.html) or
Copy file name to clipboardexpand all lines: docs/usage/administration/request_log.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Request log format
2
2
3
-
HTTP request logs are written by synapse (see [`synapse/http/site.py`](https://github.com/matrix-org/synapse/tree/develop/synapse/http/site.py) for details).
3
+
HTTP request logs are written by synapse (see [`synapse/http/site.py`](https://github.com/element.-hq/synapse/tree/develop/synapse/http/site.py) for details).
4
4
5
5
See the following for how to decode the dense data available from the default logging configuration.
Copy file name to clipboardexpand all lines: docs/usage/administration/understanding_synapse_through_grafana_graphs.md
+10-11
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
## Understanding Synapse through Grafana graphs
2
2
3
-
It is possible to monitor much of the internal state of Synapse using [Prometheus](https://prometheus.io)
4
-
metrics and [Grafana](https://grafana.com/).
5
-
A guide for configuring Synapse to provide metrics is available [here](../../metrics-howto.md)
6
-
and information on setting up Grafana is [here](https://github.com/matrix-org/synapse/tree/master/contrib/grafana).
3
+
It is possible to monitor much of the internal state of Synapse using [Prometheus](https://prometheus.io)
4
+
metrics and [Grafana](https://grafana.com/).
5
+
A guide for configuring Synapse to provide metrics is available [here](../../metrics-howto.md)
6
+
and information on setting up Grafana is [here](https://github.com/element.-hq/synapse/tree/master/contrib/grafana).
7
7
In this setup, Prometheus will periodically scrape the information Synapse provides and
8
8
store a record of it over time. Grafana is then used as an interface to query and
9
9
present this information through a series of pretty graphs.
10
10
11
-
Once you have grafana set up, and assuming you're using [our grafana dashboard template](https://github.com/matrix-org/synapse/blob/master/contrib/grafana/synapse.json), look for the following graphs when debugging a slow/overloaded Synapse:
11
+
Once you have grafana set up, and assuming you're using [our grafana dashboard template](https://github.com/element.-hq/synapse/blob/master/contrib/grafana/synapse.json), look for the following graphs when debugging a slow/overloaded Synapse:
12
12
13
13
## Message Event Send Time
14
14
@@ -57,7 +57,7 @@ Cross-referencing this with the Eviction Rate graph, which shows that entries ar
we should probably consider raising the size of that cache by raising its cache factor (a multiplier value for the size of an individual cache). Information on doing so is available [here](https://github.com/matrix-org/synapse/blob/ee421e524478c1ad8d43741c27379499c2f6135c/docs/sample_config.yaml#L608-L642) (note that the configuration of individual cache factors through the configuration file is available in Synapse v1.14.0+, whereas doing so through environment variables has been supported for a very long time). Note that this will increase Synapse's overall memory usage.
60
+
we should probably consider raising the size of that cache by raising its cache factor (a multiplier value for the size of an individual cache). Information on doing so is available [here](https://github.com/element.-hq/synapse/blob/ee421e524478c1ad8d43741c27379499c2f6135c/docs/sample_config.yaml#L608-L642) (note that the configuration of individual cache factors through the configuration file is available in Synapse v1.14.0+, whereas doing so through environment variables has been supported for a very long time). Note that this will increase Synapse's overall memory usage.
61
61
62
62
## Forward Extremities
63
63
@@ -71,14 +71,13 @@ If a room has >10 forward extremities, it's worth checking which room is the cul
0 commit comments