Update docs/installing.md #3761
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 8 commits
November 9, 2024 03:28
The instruction describes the easiest way of configuring Service Discovery (which is required for federation) should help to understand what basically to be done to finalize the installation. Signed-off-by: Suguru Hirahara <[email protected]>
…" under "Things to do next" Maintenance work by running the playbook will be required after finalizing the installation Signed-off-by: Suguru Hirahara <[email protected]>
… the headers Remove nagivations for simplicity. Signed-off-by: Suguru Hirahara <[email protected]>
The playbook tags are not limited to installation, and the explanation's detail makes the section worth being split to a dedicated individual page. Signed-off-by: Suguru Hirahara <[email protected]>
Also: mention running "just" role on maintainance Signed-off-by: Suguru Hirahara <[email protected]>
Signed-off-by: Suguru Hirahara <[email protected]>
…llation of required software Until recently there have been a lot of questions about installing, which could have been avoided if required software such as compatible version of Ansible was installed. This note should encourage those who experience basic error to troubleshoot before giving up. Signed-off-by: Suguru Hirahara <[email protected]>
Signed-off-by: Suguru Hirahara <[email protected]>
luixxiul
commented
Nov 8, 2024
docs/installing.md
Outdated
|
|
||
| However, if you do not need the base domain (`example.com`) for anything else, the easiest way of configuring it is to [serve the base domain](configuring-playbook-base-domain-serving.md) from the integrated web server. It will enable you to use a Matrix user identifier like `@<username>:example.com` while hosting services on a subdomain like `matrix.example.com`. |
There was a problem hiding this comment.
I think this should be correct according to this line, but I am not perfectly sure.
added 4 commits
November 9, 2024 03:54
Matrix is a name of the protocol and it does not really make sense to install it. Signed-off-by: Suguru Hirahara <[email protected]>
Signed-off-by: Suguru Hirahara <[email protected]>
…laybook command The concept of the just recipe is explained at the bottom of the page, therefore it should be safe to avoid using it here and prefer the ansible-playbook command like above. Signed-off-by: Suguru Hirahara <[email protected]>
Signed-off-by: Suguru Hirahara <[email protected]>
spantaleev
reviewed
Nov 9, 2024
Co-authored-by: Slavi Pantaleev <[email protected]>
Co-authored-by: Slavi Pantaleev <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main intention of this PR is:
Reduce the amount of information on
docs/installing.mdby moving the nicely detailed section for playbook tags into a dedicated pageAdd a hint of finalizing the installation by explaining the simplest way of configuring Service Discovery, which is to use the variable
matrix_static_files_container_labels_base_domain_enabledon the server dedicated for the Matrix installation.Currently this information cannot be found until you dig the article
docs/configuring-well-known.mdand thendocs/configuring-playbook-base-domain-serving.md.