2018-08-08 07:07:02 +00:00
# Table of Contents
2024-11-25 16:18:11 +00:00
## ⬇️ Installaton guides <!-- NOTE: the 🚀 emoji is used by "Getting started" on README.md -->
2021-01-21 10:39:03 +00:00
2024-11-25 16:18:11 +00:00
There are two installation guides available for beginners and advanced users.
Add "Quick start" guide (#3801)
* Add docs/quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add description about keeping the playbook and services up-to-date
Also: move descriptions about difference between the playbook tags (setup-all and install-all) and about the just "recipe" from installing.md to maintenance-upgrading-services.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace <your-username> with YOUR_USERNAME_HERE
This is a common expression and should avoid misunderstanding that `<` and `>` would need to be included
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace <your-password> with YOUR_PASSWORD_HERE
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Change the link to 'Quick start' on the breadcrumbs from README.md to quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a link to quick-start.md on the "Getting started" section
Since I am not quite sure whether the link to prerequisites.md should be replaced in favor of this link, this commit leaves it as it is for now.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a link to quick-start.md on docs/README.md
Since I am not quite sure whether the link to prerequisites.md should be replaced in favor of this link, this commit leaves it as it is for now.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add note about using "example.com" as an example domain
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove backticks from command examples to register a user
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Apply suggestions from code review
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Improve notes for instruction to create a user account
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add details about delegation to installing.md and quick-start.md
Some information is omitted on quick-start.md in favor of installing.md to keep the quick start guide simple.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add the breadcrumb header
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/quick-start.md: run the setup command with install-all by default
Refer docs/maintenance-upgrading-services.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Revert "Update docs/quick-start.md: add the breadcrumb header"
This reverts commit 9a6e1cf14c7638953fc8fbb8b487ea0afd0a41ad.
As the quick start guide is standalone.
* Update docs/quick-start.md: add headers inside the install section
These headers should make it perfectly clear that there are two steps to be done to install with the playbook
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update quick-start.md
* Update docs/registering-users.md: notes for manual user registeration
Copy the same notes from quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Reword some things in quick start
* Add alternative to `just roles`
* Update docs/configuring-dns.md: sync with docs/quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add a link to docs/registering-users.md for an instruction to add user accounts
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/registering-users.md and docs/updating-users-passwords.md: remove "your" from username and password placeholders
These documentations, unlike docs/installing.md and docs/quick-start.md, describe how to handle users (registering them or changing their passwords), some of whom are yours, while others are not.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md: add "your" to make it clear that it is "your" account that is going to be created
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md and docs/quick-start.md: mention "make roles"
This commit adds mentions to "make roles" and a note about the preference of ansible-playbook commands over the just "recipes".
quick-start.md intends to be referred by those who have never used the playbook to set up a server, so it is safer to regard that it is not clear to them what exactly the just "recipes" are made of, ie. it takes some time and experience until someone understands simplicity of them. For beginners, I believe that we should prefer the basics over simplicity, from the educational point of view.
If someone feels tired of using the same command repetitively, then the person will have been already well accustomed to the way how the playbook works and how the server is supposed to be maintained, and the person is "qualified" to use the just "recipes", and should be able to use them with confidence, distinguishing the playbook tags from the "recipes", for example, from "just install-all" and "ansible-playbook -i inventory/hosts setup.yml --tags=install-all". Such level of familiarity and experience should not be expected on the quick start guide.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update instructions to update Ansible roles
Also: move the detailed explanation about "just roles" from installing.md to maintenance-upgrading-services.md
TBD: create a dedicated documentation for the "just" program and the concept of its "recipe" (shortcut of commands)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a note about cases to create multiple accounts/users
Since one of the quick start guide's goals is to set up an own user account, this commit adds the note about creating multiple accounts/users to installing.md and registering-users.md only. It should be fine as registering-users.md is linked from quick-start.md
Also:
- On installing.md and quick-start.md, change instruction from what encourages to select "admin=yes" or "admin=no" to what encourages to use "admin=yes", since your user account will be the sole user on the server, as long as you set up the server by following the documentation
- Remove the link to registering-users.md from quick-start.md as the documentation is already linked above, under the header of the section
- Sync docs/installing.md with other documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove a line about setting "admin=yes" to reduce the amount of information
Because quick-start.md is getting longer with much information, it removes the note in favor of the linked registering-users.md documentation. The note is available on installing.md as well, and details about adding user accounts for other people can (and should) be checked on those documentations.
Also, this commit edits lines above these notes to make it clear that your user account will be an administrator of the server.
With this commit, the amount of the information about adding user accounts will be: registering-users.md > installing.md > quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Fix a broken anchor link on docs/installing.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace repetitive information about upgrading with an anchor link to docs/maintenance-upgrading-services.md
Because details to update/upgrade the Matrix services is not necessary for quick start and the amount of information should be reduced from the viewpoint of maintainability, this commit removes details to update/upgrade from quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add a note about keeping it tidy and simple
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-checking-services.md and docs/quick-start.md: add instruction to use federation tester against the base domain
Per Slavi's suggestion.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md and docs/quick-start.md: replace commands to finalize the installation
Per Slavi's suggestion.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Clarify install-matrix-static-files to avoid confusion with install-all; Minor consistency improvements
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-23 07:59:29 +00:00
2024-11-25 16:18:11 +00:00
- ⚡ ** [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".
2018-08-08 07:07:02 +00:00
2024-11-25 16:18:11 +00:00
- **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.
2018-08-08 07:07:02 +00:00
2024-11-25 16:18:11 +00:00
- [Prerequisites ](prerequisites.md )
2019-03-10 15:02:17 +00:00
2024-11-25 16:18:11 +00:00
- [Configuring your DNS settings ](configuring-dns.md )
2018-08-08 07:07:02 +00:00
2024-11-25 16:18:11 +00:00
- [Getting the playbook ](getting-the-playbook.md )
2018-08-08 07:07:02 +00:00
2024-11-25 16:18:11 +00:00
- [Configuring the playbook ](configuring-playbook.md )
2024-11-14 17:30:46 +00:00
2024-11-25 16:18:11 +00:00
- [Installing ](installing.md )
2024-11-14 17:30:46 +00:00
2024-11-25 16:18:11 +00:00
## 🛠️ Configuration options
2024-11-14 17:30:46 +00:00
2024-11-25 16:18:11 +00:00
<!--
NOTE:
- Avoid putting the same anchor links as configuring-playbook.md lists under the "configuration options" section. Note that most of them are linked to "configure-playbook-*.md" and their titles start with "Setting up" (e.g. "Setting up Hydrogen").
-->
2024-11-08 15:40:19 +00:00
2024-11-25 16:18:11 +00:00
You can check useful documentation for configuring components here: [Configuring the playbook ](configuring-playbook.md )
2020-07-14 13:25:21 +00:00
2024-12-05 06:07:33 +00:00
- [Administration ](configuring-playbook.md#administration ) - services that help you in administrating and monitoring your Matrix installation
2020-07-14 13:25:21 +00:00
2024-11-25 16:18:11 +00:00
- [Authentication and user-related ](configuring-playbook.md#authentication-and-user-related ) - extend and modify how users are authenticated on your homeserver
2020-07-14 13:25:21 +00:00
2024-11-25 16:18:11 +00:00
- [Bots ](configuring-playbook.md#bots ) - bots provide various additional functionality to your installation
2024-11-14 17:30:46 +00:00
2024-11-25 16:18:11 +00:00
- [Bridges ](configuring-playbook.md#bridging-other-networks ) - bridges can be used to connect your Matrix installation with third-party communication networks
2020-07-14 13:25:21 +00:00
2024-11-25 16:18:11 +00:00
- [Clients ](configuring-playbook.md#clients ) - web clients for Matrix that you can host on your own domains
2018-08-08 07:07:02 +00:00
2024-11-25 16:18:11 +00:00
- [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
<!-- NOTE: sort list items above alphabetically -->
- [Other specialized services ](configuring-playbook.md#other-specialized-services ) - various services that don't fit any other categories
2019-04-30 13:30:26 +00:00
2024-11-25 16:18:11 +00:00
## 👨🔧 Maintenance
2018-10-21 09:58:25 +00:00
2024-11-25 16:18:11 +00:00
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.
2018-08-08 07:07:02 +00:00
2024-11-25 16:18:11 +00:00
<!-- NOTE: sort list items alphabetically -->
2019-07-08 06:38:24 +00:00
2024-11-25 16:18:11 +00:00
- [Checking if services work ](maintenance-checking-services.md )
2018-08-08 07:07:02 +00:00
2018-11-14 20:34:24 +00:00
- [Maintenance and Troubleshooting ](maintenance-and-troubleshooting.md )
2024-11-25 16:18:11 +00:00
- [PostgreSQL maintenance ](maintenance-postgres.md )
- [Synapse maintenance ](maintenance-synapse.md )
- [Upgrading services ](maintenance-upgrading-services.md )
## Other documentation pages <!-- NOTE: this header's title and the section below need optimization -->
- ℹ ️ ** [FAQ ](faq.md )** - various Frequently Asked Questions about Matrix, with a focus on this Ansible playbook
<!-- NOTE: sort list items under faq.md alphabetically -->
- [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 )
- [Running `just` commands ](just.md )
- [Self-building ](self-building.md )
2018-11-14 20:34:24 +00:00
- [Uninstalling ](uninstalling.md )
2024-11-25 16:18:11 +00:00
- [Updating users passwords ](updating-users-passwords.md )
