From c546a7e88b36fdc88b1212a94e1a0f652b3aa329 Mon Sep 17 00:00:00 2001 From: Neil Alexander Date: Wed, 11 May 2022 12:03:19 +0100 Subject: [PATCH] More updates and permalinks --- docs/INSTALL.md | 97 +------------------ docs/PROFILING.md | 1 + docs/administration.md | 3 +- docs/codestyle.md | 1 + docs/development.md | 4 +- .../{planning.md => 1_planning.md} | 1 + .../{domainname.md => 2_domainname.md} | 1 + .../{database.md => 3_database.md} | 1 + .../{signingkey.md => 4_signingkey.md} | 1 + ...tall_monolith.md => 5_install_monolith.md} | 1 + ...tall_polylith.md => 6_install_polylith.md} | 1 + .../{configuration.md => 7_configuration.md} | 1 + docs/sytest.md | 1 + 13 files changed, 18 insertions(+), 96 deletions(-) rename docs/installation/{planning.md => 1_planning.md} (99%) rename docs/installation/{domainname.md => 2_domainname.md} (99%) rename docs/installation/{database.md => 3_database.md} (99%) rename docs/installation/{signingkey.md => 4_signingkey.md} (98%) rename docs/installation/{install_monolith.md => 5_install_monolith.md} (92%) rename docs/installation/{install_polylith.md => 6_install_polylith.md} (93%) rename docs/installation/{configuration.md => 7_configuration.md} (99%) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index b5a265c6f..c38a6dbb2 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -2,100 +2,9 @@ title: Installation has_children: true nav_order: 2 +permalink: /installation --- +# Installation - -## Starting a polylith deployment - -The following contains scripts which will run all the required processes in order to point a Matrix client at Dendrite. - -### nginx (or other reverse proxy) - -This is what your clients and federated hosts will talk to. It must forward -requests onto the correct API server based on URL: - -* `/_matrix/client` to the client API server -* `/_matrix/federation` to the federation API server -* `/_matrix/key` to the federation API server -* `/_matrix/media` to the media API server - -See `docs/nginx/polylith-sample.conf` for a sample configuration. - -### Client API server - -This is what implements CS API endpoints. Clients talk to this via the proxy in -order to send messages, create and join rooms, etc. - -```bash -./bin/dendrite-polylith-multi --config=dendrite.yaml clientapi -``` - -### Sync server - -This is what implements `/sync` requests. Clients talk to this via the proxy -in order to receive messages. - -```bash -./bin/dendrite-polylith-multi --config=dendrite.yaml syncapi -``` - -### Media server - -This implements `/media` requests. Clients talk to this via the proxy in -order to upload and retrieve media. - -```bash -./bin/dendrite-polylith-multi --config=dendrite.yaml mediaapi -``` - -### Federation API server - -This implements the federation API. Servers talk to this via the proxy in -order to send transactions. This is only required if you want to support -federation. - -```bash -./bin/dendrite-polylith-multi --config=dendrite.yaml federationapi -``` - -### Internal components - -This refers to components that are not directly spoken to by clients. They are only -contacted by other components. This includes the following components. - -#### Room server - -This is what implements the room DAG. Clients do not talk to this. - -```bash -./bin/dendrite-polylith-multi --config=dendrite.yaml roomserver -``` - -#### Appservice server - -This sends events from the network to [application -services](https://matrix.org/docs/spec/application_service/unstable.html) -running locally. This is only required if you want to support running -application services on your homeserver. - -```bash -./bin/dendrite-polylith-multi --config=dendrite.yaml appservice -``` - -#### Key server - -This manages end-to-end encryption keys for users. - -```bash -./bin/dendrite-polylith-multi --config=dendrite.yaml keyserver -``` - -#### User server - -This manages user accounts, device access tokens and user account data, -amongst other things. - -```bash -./bin/dendrite-polylith-multi --config=dendrite.yaml userapi -``` +This section contains documentation on installing a new Dendrite deployment. diff --git a/docs/PROFILING.md b/docs/PROFILING.md index 08b055219..f3b573472 100644 --- a/docs/PROFILING.md +++ b/docs/PROFILING.md @@ -1,6 +1,7 @@ --- title: Profiling parent: Development +permalink: /development/profiling --- # Profiling Dendrite diff --git a/docs/administration.md b/docs/administration.md index 370384c7d..08ad7803e 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -2,8 +2,9 @@ title: Administration has_children: yes nav_order: 4 +permalink: /administration --- # Administration -Section on managing your Dendrite server. +This section contains documentation on managing your existing Dendrite deployment. diff --git a/docs/codestyle.md b/docs/codestyle.md index 41fc03646..7e3f50a0f 100644 --- a/docs/codestyle.md +++ b/docs/codestyle.md @@ -1,6 +1,7 @@ --- title: Code Style parent: Development +permalink: /development/codestyle --- # Code Style diff --git a/docs/development.md b/docs/development.md index d13982bbb..cf296fb53 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,8 +1,10 @@ --- title: Development has_children: true +permalink: /development --- # Development -The documents in this section will be useful when developing against Dendrite. +This section contains documentation that may be useful when helping to develop +Dendrite. diff --git a/docs/installation/planning.md b/docs/installation/1_planning.md similarity index 99% rename from docs/installation/planning.md rename to docs/installation/1_planning.md index a102b9b77..b04b46e3a 100644 --- a/docs/installation/planning.md +++ b/docs/installation/1_planning.md @@ -2,6 +2,7 @@ title: Planning your installation parent: Installation nav_order: 1 +permalink: /installation/planning --- # Planning your installation diff --git a/docs/installation/domainname.md b/docs/installation/2_domainname.md similarity index 99% rename from docs/installation/domainname.md rename to docs/installation/2_domainname.md index cd0f1e84e..0d4300eca 100644 --- a/docs/installation/domainname.md +++ b/docs/installation/2_domainname.md @@ -2,6 +2,7 @@ title: Setting up the domain parent: Installation nav_order: 2 +permalink: /installation/domainname --- # Setting up the domain diff --git a/docs/installation/database.md b/docs/installation/3_database.md similarity index 99% rename from docs/installation/database.md rename to docs/installation/3_database.md index 9458b5157..46b600c98 100644 --- a/docs/installation/database.md +++ b/docs/installation/3_database.md @@ -2,6 +2,7 @@ title: Preparing database storage parent: Installation nav_order: 3 +permalink: /installation/database --- # Preparing database storage diff --git a/docs/installation/signingkey.md b/docs/installation/4_signingkey.md similarity index 98% rename from docs/installation/signingkey.md rename to docs/installation/4_signingkey.md index f3e4e36ee..07dc485ff 100644 --- a/docs/installation/signingkey.md +++ b/docs/installation/4_signingkey.md @@ -2,6 +2,7 @@ title: Generating signing keys parent: Installation nav_order: 4 +permalink: /installation/signingkeys --- # Generating signing keys diff --git a/docs/installation/install_monolith.md b/docs/installation/5_install_monolith.md similarity index 92% rename from docs/installation/install_monolith.md rename to docs/installation/5_install_monolith.md index 58750e045..e7d90c52b 100644 --- a/docs/installation/install_monolith.md +++ b/docs/installation/5_install_monolith.md @@ -3,6 +3,7 @@ title: Installing as a monolith parent: Installation has_toc: true nav_order: 5 +permalink: /installation/install/monolith --- # Installing as a monolith diff --git a/docs/installation/install_polylith.md b/docs/installation/6_install_polylith.md similarity index 93% rename from docs/installation/install_polylith.md rename to docs/installation/6_install_polylith.md index 54ad8a293..dd0fc731f 100644 --- a/docs/installation/install_polylith.md +++ b/docs/installation/6_install_polylith.md @@ -3,6 +3,7 @@ title: Installing as a polylith parent: Installation has_toc: true nav_order: 6 +permalink: /installation/install/polylith --- # Installing as a polylith diff --git a/docs/installation/configuration.md b/docs/installation/7_configuration.md similarity index 99% rename from docs/installation/configuration.md rename to docs/installation/7_configuration.md index 247fd809e..5c526f388 100644 --- a/docs/installation/configuration.md +++ b/docs/installation/7_configuration.md @@ -2,6 +2,7 @@ title: Populate the configuration parent: Installation nav_order: 7 +permalink: /installation/configuration --- # Populate the configuration diff --git a/docs/sytest.md b/docs/sytest.md index da78ad595..3cfb99e60 100644 --- a/docs/sytest.md +++ b/docs/sytest.md @@ -1,6 +1,7 @@ --- title: SyTest parent: Development +permalink: /development/sytest --- # SyTest