From fb82b4672301b27bc5da9a9d3b668e37cd17a487 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 26 Nov 2024 01:18:11 +0900 Subject: [PATCH] Update docs/README.md (#3822) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update docs/README.md: add "installation guides" section Add the emoji to the link to quick-start.md only and not to full installation guide to emphasize the quick start guide Signed-off-by: Suguru Hirahara * Update docs/README.md: move a link to faq.md down Signed-off-by: Suguru Hirahara * Update docs/README.md: add "Maintenance" section Add a hint to join the support room under "Maintenance" header. Signed-off-by: Suguru Hirahara * Update docs/README.md: create the "configuration options" section and add a note Signed-off-by: Suguru Hirahara * Update docs/README.md: sort list items Signed-off-by: Suguru Hirahara * Update docs/README.md: emphasize the anchor link to faq.md Signed-off-by: Suguru Hirahara * Update docs/README.md: add other anchor links to the "other documentation pages" section Signed-off-by: Suguru Hirahara * Update docs/README.md: add the emoji ℹī¸ before the anchor link to faq.md Signed-off-by: Suguru Hirahara * Update docs/README.md: explanation about FAQ Remove the hint to check the installation guides as links to them are listed on top of this page. Signed-off-by: Suguru Hirahara * Update docs/README.md: update text of the anchor link to docs/getting-the-playbook.md Signed-off-by: Suguru Hirahara --------- Signed-off-by: Suguru Hirahara Co-authored-by: Suguru Hirahara --- docs/README.md | 87 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 62 insertions(+), 25 deletions(-) diff --git a/docs/README.md b/docs/README.md index 1b681bc88..7ab368150 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,49 +1,86 @@ # Table of Contents -- [FAQ](faq.md) - lots of questions and answers. Jump to [Prerequisites](prerequisites.md) to avoid reading too much and to just start a guided installation. +## âŦ‡ī¸ Installaton guides -- [Quick start](quick-start.md) - follow the guide to set up minimum core services on your server +There are two installation guides available for beginners and advanced users. -- [Prerequisites](prerequisites.md) - go here to a guided installation using this Ansible playbook +- ⚡ **[Quick start](quick-start.md) (for beginners)**: this is recommended for those who do not have an existing Matrix server and want to start quickly with "opinionated defaults". -- [Configuring your DNS settings](configuring-dns.md) +- **Full installation guide (for advanced users)**: if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide. -- [Getting this playbook's source code](getting-the-playbook.md) + - [Prerequisites](prerequisites.md) -- [Configuring the playbook](configuring-playbook.md) + - [Configuring your DNS settings](configuring-dns.md) -- [Installing](installing.md) + - [Getting the playbook](getting-the-playbook.md) - - **Importing data from another server installation** + - [Configuring the playbook](configuring-playbook.md) - - [Importing an existing SQLite database (from another Synapse installation)](importing-synapse-sqlite.md) (optional) + - [Installing](installing.md) - - [Importing an existing Postgres database (from another installation)](importing-postgres.md) (optional) +## 🛠ī¸ Configuration options - - [Importing `media_store` data files from an existing Synapse installation](importing-synapse-media-store.md) (optional) + - - [Server Delegation](howto-server-delegation.md) +You can check useful documentation for configuring components here: [Configuring the playbook](configuring-playbook.md) - - Server Delegation via a well-known file (recommended): [Installing well-known files on the base domain's server](configuring-well-known.md#installing-well-known-files-on-the-base-domain-s-server) +- [Administration](configuring-playbook.md#administration) - services that help you in administrating and monitoring your Matrix installation - - [Serving the base domain](configuring-playbook-base-domain-serving.md) +- [Authentication and user-related](configuring-playbook.md#authentication-and-user-related) - extend and modify how users are authenticated on your homeserver - - [Server Delegation via a DNS SRV record (advanced)](howto-srv-server-delegation.md) +- [Bots](configuring-playbook.md#bots) - bots provide various additional functionality to your installation + +- [Bridges](configuring-playbook.md#bridging-other-networks) - bridges can be used to connect your Matrix installation with third-party communication networks + +- [Clients](configuring-playbook.md#clients) - web clients for Matrix that you can host on your own domains + +- [Core service adjustments](configuring-playbook.md#core-service-adjustments) - backbone of your Matrix system + +- [File Storage](configuring-playbook.md#file-storage) - use alternative file storage to the default `media_store` folder + + + +- [Other specialized services](configuring-playbook.md#other-specialized-services) - various services that don't fit any other categories + +## 👨‍🔧 Maintenance + +If your server and services experience issues, feel free to come to [our support room](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) and ask for help. + + + +- [Checking if services work](maintenance-checking-services.md) + +- [Maintenance and Troubleshooting](maintenance-and-troubleshooting.md) + +- [PostgreSQL maintenance](maintenance-postgres.md) + +- [Synapse maintenance](maintenance-synapse.md) + +- [Upgrading services](maintenance-upgrading-services.md) + +## Other documentation pages + +- ℹī¸ **[FAQ](faq.md)** - various Frequently Asked Questions about Matrix, with a focus on this Ansible playbook + + + +- [Alternative architectures](alternative-architectures.md) + +- [Container images used by the playbook](container-images.md) + +- [Obtaining an Access Token](obtaining-access-tokens.md) - [Playbook tags](playbook-tags.md) - [Registering users](registering-users.md) -- [Updating users passwords](updating-users-passwords.md) +- [Running `just` commands](just.md) -- [Maintenance / checking if services work](maintenance-checking-services.md) - -- [Maintenance / upgrading services](maintenance-upgrading-services.md) - -- [Maintenance / Synapse](maintenance-synapse.md) - -- [Maintenance / PostgreSQL](maintenance-postgres.md) - -- [Maintenance and Troubleshooting](maintenance-and-troubleshooting.md) +- [Self-building](self-building.md) - [Uninstalling](uninstalling.md) + +- [Updating users passwords](updating-users-passwords.md)