From 68e4e127ab570cb68cd74be51ca81846265fa85b Mon Sep 17 00:00:00 2001 From: Hans van Zijst Date: Mon, 4 Nov 2024 15:13:18 +0100 Subject: [PATCH] Moved Synapse documentation to 'synapse'. --- README.md | 35 +---------------------------------- synapse/README.md | 34 ++++++++++++++++++++++++++++++++-- 2 files changed, 33 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index ca4a332..33e4209 100644 --- a/README.md +++ b/README.md @@ -26,40 +26,7 @@ tracking](https://element-hq.github.io/synapse/latest/consent_tracking.html) # Synapse -We'll use Synapse, using the workers architecture to make it scalable, flexible and reusable. - -Mind you: this an installation on Debian Linux (at least for now). - -Start by installing the latest Synapse server, see the [upstream -documentation](https://element-hq.github.io/synapse/latest/setup/installation.html). - -``` -apt install -y lsb-release wget apt-transport-https build-essential python3-dev libffi-dev \ - python3-pip python3-setuptools sqlite3 \ - libssl-dev virtualenv libjpeg-dev libxslt1-dev libicu-dev - -wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg - -echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" | - tee /etc/apt/sources.list.d/matrix-org.list - -apt update -apt install matrix-synapse-py3 -``` - -This leaves a very basic configuration in `/etc/matrix-synapse/homeserver.yaml` -and two settings under `/etc/conf.d`. All other configuration items will also -be configured with yaml-files in this directory. - -Configure the domain you with to use in `/etc/matrix-synapse/conf.d/server_name.yaml`. -What you configure here will also be the global part of your Matrix handles -(the part after the colon). - -You now have a standard Matrix server that uses sqlite. You really don't want -to use this in production, so probably want to replace this with PostgreSQL. - - -Further configuration is documented under [synapse](synapse). +Configuration is documented under [synapse](synapse). ## Logging diff --git a/synapse/README.md b/synapse/README.md index 8a326a6..25e374f 100644 --- a/synapse/README.md +++ b/synapse/README.md @@ -5,9 +5,39 @@ include_toc: true # Installation and configuration of Synapse -There are two different ways to install Synapse, documented here: +Mind you: this an installation on Debian Linux (at least for now). + +Start by installing the latest Synapse server, see the [upstream +documentation](https://element-hq.github.io/synapse/latest/setup/installation.html). + +``` +apt install -y lsb-release wget apt-transport-https build-essential python3-dev libffi-dev \ + python3-pip python3-setuptools sqlite3 \ + libssl-dev virtualenv libjpeg-dev libxslt1-dev libicu-dev + +wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg + +echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" | + tee /etc/apt/sources.list.d/matrix-org.list + +apt update +apt install matrix-synapse-py3 +``` + +This leaves a very basic configuration in `/etc/matrix-synapse/homeserver.yaml` +and two settings under `/etc/conf.d`. All other configuration items will also +be configured with yaml-files in this directory. + +Configure the domain you with to use in `/etc/matrix-synapse/conf.d/server_name.yaml`. +What you configure here will also be the global part of your Matrix handles +(the part after the colon). + +You now have a standard Matrix server that uses sqlite. You really don't want +to use this in production, so probably want to replace this with PostgreSQL. + +There are two different ways to configure Synapse, documented here: * [Monolithic](monolithic) * [Workers](workers) - +We'll use Synapse, using the workers architecture to make it scalable, flexible and reusable.