mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-14 11:57:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update documentation to refer to element-hq.

Browse source
This commit is contained in:
Patrick Cloke 2023-11-20 14:22:46 -05:00 committed by Erik Johnston
parent 23a919d267
commit 837391cdbb
8 changed files with 36 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/FUNDING.yml vendored
View file

@ -1,4 +0,0 @@
# One username per supported platform and one custom link
patreon: matrixdotorg
liberapay: matrixdotorg
custom: https://paypal.me/matrixdotorg

10
.github/ISSUE_TEMPLATE/BUG_REPORT.yml vendored
View file

@ -86,7 +86,7 @@ body:
If PostgreSQL, please also answer the following: If PostgreSQL, please also answer the following:
- are you using a single PostgreSQL server - are you using a single PostgreSQL server
or [separate servers for `main` and `state`](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#databases)? or [separate servers for `main` and `state`](https://vector-im.github.io/synapse/latest/usage/configuration/config_documentation.html#databases)?
- have you previously ported from SQLite using the Synapse "portdb" script? - have you previously ported from SQLite using the Synapse "portdb" script?
- have you previously restored from a backup? - have you previously restored from a backup?
validations: validations:
@ -97,7 +97,7 @@ body:
label: Workers label: Workers
description: | description: |
Are you running a single Synapse process, or are you running Are you running a single Synapse process, or are you running
[2 or more workers](https://matrix-org.github.io/synapse/latest/workers.html)? [2 or more workers](https://vector-im.github.io/synapse/latest/workers.html)?
options: options:
- Single process - Single process
- Multiple workers - Multiple workers
@ -121,9 +121,9 @@ body:
Do you have any unusual config options turned on? If so, please provide details. Do you have any unusual config options turned on? If so, please provide details.
- Experimental or undocumented features - Experimental or undocumented features
- [Presence](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#presence) - [Presence](https://vector-im.github.io/synapse/latest/usage/configuration/config_documentation.html#presence)
- [Message retention](https://matrix-org.github.io/synapse/latest/message_retention_policies.html) - [Message retention](https://vector-im.github.io/synapse/latest/message_retention_policies.html)
- [Synapse modules](https://matrix-org.github.io/synapse/latest/modules/index.html) - [Synapse modules](https://vector-im.github.io/synapse/latest/modules/index.html)
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:

36
docs/development/contributing_guide.md
View file

@ -4,14 +4,16 @@ This document aims to get you started with contributing to Synapse!
# 1. Who can contribute to Synapse? # 1. Who can contribute to Synapse?
Everyone is welcome to contribute code to [matrix.org Everyone is welcome to contribute code to [Synapse](https://github.com/element-hq/synapse),
projects](https://github.com/matrix-org), provided that they are willing to provided that they are willing to
license their contributions under the same license as the project itself. We license their contributions under the same license as the project itself. We
follow a simple 'inbound=outbound' model for contributions: the act of follow a simple 'inbound=outbound' model for contributions: the act of
submitting an 'inbound' contribution means that the contributor agrees to submitting an 'inbound' contribution means that the contributor agrees to
license the code under the same terms as the project's overall 'outbound' license the code under the same terms as the project's overall 'outbound'
license - in our case, this is almost always Apache Software License v2 (see license - in our case, this is almost always Apache Software License v2 (see
[LICENSE](https://github.com/matrix-org/synapse/blob/develop/LICENSE)). [LICENSE](https://github.com/element-hq/synapse/blob/develop/LICENSE)).
TODO THIS NEEDS UPDATING
# 2. What do I need? # 2. What do I need?
@ -97,8 +99,8 @@ Now edit `homeserver.yaml`, things you might want to change include:
- Set a `server_name` - Set a `server_name`
- Adjusting paths to be correct for your system like the `log_config` to point to the log config you just copied - Adjusting paths to be correct for your system like the `log_config` to point to the log config you just copied
- Using a [PostgreSQL database instead of SQLite](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#database) - Using a [PostgreSQL database instead of SQLite](https://vector-im.github.io/synapse/latest/usage/configuration/config_documentation.html#database)
- Adding a [`registration_shared_secret`](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#registration_shared_secret) so you can use [`register_new_matrix_user` command](https://matrix-org.github.io/synapse/latest/setup/installation.html#registering-a-user). - Adding a [`registration_shared_secret`](https://vector-im.github.io/synapse/latest/usage/configuration/config_documentation.html#registration_shared_secret) so you can use [`register_new_matrix_user` command](https://vector-im.github.io/synapse/latest/setup/installation.html#registering-a-user).
And then run Synapse with the following command: And then run Synapse with the following command:
@ -122,22 +124,22 @@ Join our developer community on Matrix: [#synapse-dev:matrix.org](https://matrix
# 6. Pick an issue. # 6. Pick an issue.
Fix your favorite problem or perhaps find a [Good First Issue](https://github.com/matrix-org/synapse/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22) Fix your favorite problem or perhaps find a [Good First Issue](https://github.com/element-hq/synapse/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22)
to work on. to work on.
# 7. Turn coffee into code and documentation! # 7. Turn coffee into code and documentation!
There is a growing amount of documentation located in the There is a growing amount of documentation located in the
[`docs`](https://github.com/matrix-org/synapse/tree/develop/docs) [`docs`](https://github.com/element-hq/synapse/tree/develop/docs)
directory, with a rendered version [available online](https://matrix-org.github.io/synapse). directory, with a rendered version [available online](https://vector-im.github.io/synapse).
This documentation is intended primarily for sysadmins running their This documentation is intended primarily for sysadmins running their
own Synapse instance, as well as developers interacting externally with own Synapse instance, as well as developers interacting externally with
Synapse. Synapse.
[`docs/development`](https://github.com/matrix-org/synapse/tree/develop/docs/development) [`docs/development`](https://github.com/element-hq/synapse/tree/develop/docs/development)
exists primarily to house documentation for exists primarily to house documentation for
Synapse developers. Synapse developers.
[`docs/admin_api`](https://github.com/matrix-org/synapse/tree/develop/docs/admin_api) houses documentation [`docs/admin_api`](https://github.com/element-hq/synapse/tree/develop/docs/admin_api) houses documentation
regarding Synapse's Admin API, which is used mostly by sysadmins and external regarding Synapse's Admin API, which is used mostly by sysadmins and external
service developers. service developers.
@ -147,14 +149,10 @@ options and documentation](../code_style.md#configuration-code-and-documentation
We welcome improvements and additions to our documentation itself! When We welcome improvements and additions to our documentation itself! When
writing new pages, please writing new pages, please
[build `docs` to a book](https://github.com/matrix-org/synapse/tree/develop/docs#adding-to-the-documentation) [build `docs` to a book](https://github.com/element-hq/synapse/tree/develop/docs#adding-to-the-documentation)
to check that your contributions render correctly. The docs are written in to check that your contributions render correctly. The docs are written in
[GitHub-Flavoured Markdown](https://guides.github.com/features/mastering-markdown/). [GitHub-Flavoured Markdown](https://guides.github.com/features/mastering-markdown/).
Some documentation also exists in [Synapse's GitHub
Wiki](https://github.com/matrix-org/synapse/wiki), although this is primarily
contributed to by community authors.
When changes are made to any Rust code then you must call either `poetry install` When changes are made to any Rust code then you must call either `poetry install`
or `maturin develop` (if installed) to rebuild the Rust code. Using [`maturin`](https://github.com/PyO3/maturin) or `maturin develop` (if installed) to rebuild the Rust code. Using [`maturin`](https://github.com/PyO3/maturin)
is quicker than `poetry install`, so is recommended when making frequent is quicker than `poetry install`, so is recommended when making frequent
@ -331,7 +329,7 @@ This configuration should generally cover your needs.
- To run with Postgres, supply the `-e POSTGRES=1 -e MULTI_POSTGRES=1` environment flags. - To run with Postgres, supply the `-e POSTGRES=1 -e MULTI_POSTGRES=1` environment flags.
- To run with Synapse in worker mode, supply the `-e WORKERS=1 -e REDIS=1` environment flags (in addition to the Postgres flags). - To run with Synapse in worker mode, supply the `-e WORKERS=1 -e REDIS=1` environment flags (in addition to the Postgres flags).
For more details about other configurations, see the [Docker-specific documentation in the SyTest repo](https://github.com/matrix-org/sytest/blob/develop/docker/README.md). For more details about other configurations, see the [Docker-specific documentation in the SyTest repo](https://github.com/vector-im/sytest/blob/develop/docker/README.md).
## Run the integration tests ([Complement](https://github.com/matrix-org/complement)). ## Run the integration tests ([Complement](https://github.com/matrix-org/complement)).
@ -365,7 +363,7 @@ The above will run a monolithic (single-process) Synapse with SQLite as the data
- If setting `WORKERS=1`, optionally set `WORKER_TYPES=` to declare which worker - If setting `WORKERS=1`, optionally set `WORKER_TYPES=` to declare which worker
types you wish to test. A simple comma-delimited string containing the worker types types you wish to test. A simple comma-delimited string containing the worker types
defined from the `WORKERS_CONFIG` template in defined from the `WORKERS_CONFIG` template in
[here](https://github.com/matrix-org/synapse/blob/develop/docker/configure_workers_and_start.py#L54). [here](https://github.com/element-hq/synapse/blob/develop/docker/configure_workers_and_start.py#L54).
A safe example would be `WORKER_TYPES="federation_inbound, federation_sender, synchrotron"`. A safe example would be `WORKER_TYPES="federation_inbound, federation_sender, synchrotron"`.
See the [worker documentation](../workers.md) for additional information on workers. See the [worker documentation](../workers.md) for additional information on workers.
- Passing `ASYNCIO_REACTOR=1` as an environment variable to use the Twisted asyncio reactor instead of the default one. - Passing `ASYNCIO_REACTOR=1` as an environment variable to use the Twisted asyncio reactor instead of the default one.
@ -434,7 +432,7 @@ in the format of `PRnumber.type`. The type can be one of the following:
* `misc` (for internal-only changes) * `misc` (for internal-only changes)
This file will become part of our [changelog]( This file will become part of our [changelog](
https://github.com/matrix-org/synapse/blob/master/CHANGES.md) at the next https://github.com/element-hq/synapse/blob/master/CHANGES.md) at the next
release, so the content of the file should be a short description of your release, so the content of the file should be a short description of your
change in the same style as the rest of the changelog. The file can contain Markdown change in the same style as the rest of the changelog. The file can contain Markdown
formatting, and must end with a full stop (.) or an exclamation mark (!) for formatting, and must end with a full stop (.) or an exclamation mark (!) for
@ -466,7 +464,7 @@ There are two options for solving this:
add the changelog file to your branch, or: add the changelog file to your branch, or:
1. Look at the [list of all 1. Look at the [list of all
issues/PRs](https://github.com/matrix-org/synapse/issues?q=), add one to the issues/PRs](https://github.com/element-hq/synapse/issues?q=), add one to the
highest number you see, and quickly open the PR before somebody else claims highest number you see, and quickly open the PR before somebody else claims
your number. your number.

4
docs/development/dependencies.md
View file

@ -79,9 +79,9 @@ phonenumbers = [
We can see this pinned version inside the docker image for that release: We can see this pinned version inside the docker image for that release:
``` ```
$ docker pull matrixdotorg/synapse:v1.57.0 $ docker pull vectorim/synapse:v1.97.0
... ...
$ docker run --entrypoint pip matrixdotorg/synapse:v1.57.0 show phonenumbers $ docker run --entrypoint pip vectorim/synapse:v1.97.0 show phonenumbers
Name: phonenumbers Name: phonenumbers
Version: 8.12.44 Version: 8.12.44
Summary: Python version of Google's common library for parsing, formatting, storing and validating international phone numbers. Summary: Python version of Google's common library for parsing, formatting, storing and validating international phone numbers.

2
docs/manhole.md
View file

@ -38,7 +38,7 @@ docker run -d --name synapse \
--mount type=volume,src=synapse-data,dst=/data \ --mount type=volume,src=synapse-data,dst=/data \
-p 8008:8008 \ -p 8008:8008 \
-p 127.0.0.1:9000:9000 \ -p 127.0.0.1:9000:9000 \
matrixdotorg/synapse:latest vectorim/synapse:latest
``` ```
#### Native config #### Native config

6
docs/setup/installation.md
View file

@ -26,9 +26,9 @@ for most users.
#### Docker images and Ansible playbooks #### Docker images and Ansible playbooks
There is an official synapse image available at There is an official synapse image available at
<https://hub.docker.com/r/matrixdotorg/synapse> or at [`ghcr.io/matrix-org/synapse`](https://ghcr.io/matrix-org/synapse) <https://hub.docker.com/r/vectorim/synapse> or at [`ghcr.io/element-hq/synapse`](https://ghcr.io/element-hq/synapse)
which can be used with the docker-compose file available at which can be used with the docker-compose file available at
[contrib/docker](https://github.com/matrix-org/synapse/tree/develop/contrib/docker). [contrib/docker](https://github.com/element-hq/synapse/tree/develop/contrib/docker).
Further information on this including configuration options is available in the README Further information on this including configuration options is available in the README
on hub.docker.com. on hub.docker.com.
@ -52,6 +52,8 @@ architecture via <https://packages.matrix.org/debian/>.
To install the latest release: To install the latest release:
TODO UPDATE ALL THIS
```sh ```sh
sudo apt install -y lsb-release wget apt-transport-https sudo apt install -y lsb-release wget apt-transport-https
sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg

14
docs/welcome_and_overview.md
View file

@ -1,8 +1,7 @@
# Introduction # Introduction
Welcome to the documentation repository for Synapse, a Welcome to the documentation repository for Synapse, a
[Matrix](https://matrix.org) homeserver implementation developed by the matrix.org core [Matrix](https://matrix.org) homeserver implementation developed by Element.
team.
## Installing and using Synapse ## Installing and using Synapse
@ -61,17 +60,6 @@ following documentation:
* And finally, contribute to this documentation! The source for which is * And finally, contribute to this documentation! The source for which is
[located here](https://github.com/matrix-org/synapse/tree/develop/docs). [located here](https://github.com/matrix-org/synapse/tree/develop/docs).
## Donating to Synapse development
Want to help keep Synapse going but don't know how to code? Synapse is a
[Matrix.org Foundation](https://matrix.org) project. Consider becoming a
supporter on [Liberapay](https://liberapay.com/matrixdotorg),
[Patreon](https://patreon.com/matrixdotorg) or through
[PayPal](https://paypal.me/matrixdotorg) via a one-time donation.
If you are an organisation or enterprise and would like to sponsor development,
reach out to us over email at: support (at) matrix.org
## Reporting a security vulnerability ## Reporting a security vulnerability
If you've found a security issue in Synapse or any other Matrix.org Foundation If you've found a security issue in Synapse or any other Matrix.org Foundation

6
docs/workers.md
View file

@ -62,8 +62,8 @@ pip install "matrix-synapse[redis]"
Note that these dependencies are included when synapse is installed with `pip Note that these dependencies are included when synapse is installed with `pip
install matrix-synapse[all]`. They are also included in the debian packages from install matrix-synapse[all]`. They are also included in the debian packages from
`matrix.org` and in the docker images at `packages.element.io` and in the docker images at
https://hub.docker.com/r/matrixdotorg/synapse/. https://hub.docker.com/r/ectorim/synapse/.
To make effective use of the workers, you will need to configure an HTTP To make effective use of the workers, you will need to configure an HTTP
reverse-proxy such as nginx or haproxy, which will direct incoming requests to reverse-proxy such as nginx or haproxy, which will direct incoming requests to
@ -629,7 +629,7 @@ worker application type.
You can designate generic worker to sending push notifications to You can designate generic worker to sending push notifications to
a [push gateway](https://spec.matrix.org/v1.5/push-gateway-api/) such as a [push gateway](https://spec.matrix.org/v1.5/push-gateway-api/) such as
[sygnal](https://github.com/matrix-org/sygnal) and email. [sygnal](https://github.com/vector-im/sygnal) and email.
This will stop the main process sending push notifications. This will stop the main process sending push notifications.