Commit Graph

1611 Commits

Author SHA1 Message Date
d617f4247c Update docs/registering-users.md: fix broken anchor links
The anchor link has stopped working with 30c53cdea2.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-23 13:41:04 +09:00
e8ae798423 Replace the warning emoji in text style (U+26A0 FE0E) to emoji style (U+26A0 FE0F)
This change makes it possible for terminals to render warning emoji in actual emoji (⚠️), not in text style (⚠).

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-23 01:11:15 +09:00
0c9fc4358d Fix variable name typos (matrix_playbook_reverse_proxy_traefik_middleware_compession_* -> matrix_playbook_reverse_proxy_traefik_middleware_compression_*)
Supersedes https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3803
2024-11-21 12:23:01 +02:00
e2d31ec9c3 Update docs/configuring-playbook-ma1sd.md (#3795)
* Update docs/configuring-playbook-ma1sd.md: edit top paragraphs

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-ma1sd.md: use common expressions for instruction to add configuration

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-ma1sd.md: move instructions up

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-ma1sd.md: move the instruction for additional features up

Move instructions for features which use the "matrix_ma1sd_configuration_extension_yaml" variable under "Additional features".

Also: adjust headers' level

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-ma1sd.md

Co-authored-by: Slavi Pantaleev <slavi@devture.com>

* Update configuring-playbook-ma1sd.md: adjust to follow other examples such as on configuring-playbook-bridge-appservice-webhooks.md

This commit:

- Move the note about installing to the top
- Add warning emoji (⚠️: U+26A0 FE0F)
- Use a common expression to discourage installing

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-ma1sd.md: move instruction to configure DNS settings up

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Fix typo and add an extra newline

---------

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-21 11:14:00 +02:00
b1dec4a123 Edit docs/prerequisites.md: add an anchor link to the official documentation of passlib
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 15:46:26 +09:00
e38f433177 Edit docs/prerequisites.md: add an introductory paragraph
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 15:41:26 +09:00
12b67f7925 Edit docs/prerequisites.md: entries for local computer
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 15:41:04 +09:00
43d1760077 Edit docs/prerequisites.md: move the section for the local computer up
This change should make it easier to notice Ansible version requirement

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 15:40:44 +09:00
c7148d8b05 Edit docs/prerequisites.md: remove instructions to install whether on the remove server or on your local computer
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 15:40:20 +09:00
39c21816ca Edit docs/prerequisites.md: create categories for required software on the remote server and local computer
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 15:39:54 +09:00
01bed6d512 Edit docs/prerequisites.md: add an item for a password generator
Since it is required to create and input a strong password (random strings) on vars.yml, this commit adds a password generator as a required software to configure and run the playbook. Password Tech, reportedly formerly known as "PWGen for Windows", is linked from https://github.com/jbernard/pwgen

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 15:39:13 +09:00
54af9606db Fix incorrect variable name in docs/howto-srv-server-delegation.md (traefik_environment_variables -> traefik_environment_variables_additional_variables)
Ref: a008706c32/defaults/main.yml (L109-L115)
2024-11-18 07:44:44 +02:00
0df0f8578e Update docs/registering-users.md: remove a section for recommending delegation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 12:23:25 +09:00
6e9c143d56 Update docs/registering-users.md: add details about delegation
The change is based on 7e45325338.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 00:50:26 +09:00
7e45325338 Update docs/installing.md: add "Create your user account" section before "Finalize the installation" (#3789)
* Update docs/installing.md: add "Create your user account" section before "Finalize the installation"

docs/registering-users.md has correctly instructed that service delegation should be conducted after creating user accounts to finalize the installation process.

Since it does not really make sense to claim that installation has finished if there is not a user, this commit adds instruction to create a user account before configuring server delegation.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/installing.md

Co-authored-by: Slavi Pantaleev <slavi@devture.com>

* Update installing.md: remove a whitespace character

---------

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-17 17:42:12 +02:00
5e4c930d90 Fix broken anchor links
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 21:30:47 +09:00
8f11e1d5bc Update docs/configuring-playbook-bridge-hookshot.md: fix link to main.yml
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 20:24:01 +09:00
a6cdb2c571 Update docs/configuring-dns.md (#3786)
* Update docs/configuring-dns.md: add note about DNS settings for default services

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md and docs/configuring-playbook-ma1sd.md: move the DNS setting (SRV record) for ma1sd to the latter

Edit instruction to enable a SRV record for ma1sd.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: remove repetitive explanations about necessity of subdomain settings

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: move explanation about subdomain settings up

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: fix tables layout

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: edit the section for TXT and MX records

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: move the row for ma1sd under the rows for CNAME records

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: replace "may be necessary" with "is necessary" as Element Web is installed by default

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: add a note about setting a SRV record for ma1sd

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: use the same string for IP address placeholder

Also: adjust the table's layout

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: simplify the header for postmoogle DNS records configuration

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: switch the order of TXT and MX moogle for Postmoogle

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: simplify instructions for ma1sd and Postmoogle

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: fix the anchor link to rageshake documentation

The issue was introduced with ea6e879487

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 10:10:40 +02:00
3c23b643d8 Edit docs/configuring-playbook-client-schildichat-web.md: update the paragraph for warning
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 15:50:21 +09:00
4f87328ff1 Mention publicly hosted services for SchildiChat
This commit basically follows 3a11881120.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 15:50:14 +09:00
d8c288c941 Merge pull request #3784 from xylobol/patch-1
Correct issuer URL in OIDC example section
2024-11-17 08:48:59 +02:00
ab3c4edea7 Correct issuer URL in OIDC example section
Keycloak exposes the issuer information on /realms/whatever, not /auth/realms/whatever.
2024-11-16 20:56:15 -07:00
135039b276 Change "Configuring your DNS server" to "Configuring your DNS settings"
Essentially it means "configuring your DNS settings or records on the DNS server you use".

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 12:06:30 +09:00
ac02351ab7 Update docs/configuring-playbook.md and docs/installing.md: remove anchor links to other installation procedure pages
They are redundant as there are breadcrumbs on each page

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-16 23:47:41 +09:00
76e6bf3966 Remove redundante whitespace characters from the breadcrumbs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-16 23:47:18 +09:00
439e012f03 Add U+25B6 (BLACK RIGHT-POINTING TRIANGLE) characters to installation procedure navigation
Set anchor links to those characters as well.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-16 23:44:11 +09:00
c97dbc9ec6 Update docs/howto-server-delegation.md: related to removal of matrix-nginx-proxy
The current ToC was added by 065b70203d, but the links were initially added by ef903fe544 as a navigation to sections under them. This commit replaces the ToC with such navigation.

Also, one of the sections was removed by f4f3d57520, and since matrix-nginx-proxy was removed, it seems to me that letting Synapse handle Federation by itself would be simpler than the other method which requires setting another webserver. Therefore this commit switches the alternative method from using another webserver to using Synapse.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-16 17:36:46 +09:00
f19cbe6dd4 Edit documentation related to server delegation (#3773)
* Update docs/configuring-playbook-base-domain-serving.md: add an anchor link to docs/configuring-dns.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update documentation related to server delegation

Summary:
- Add explanation about server delegation and DNS setting for it to docs/configuring-dns.md; "delegation" is a technical term and it is worth being explained simply
- Edit explanation about delegation to docs/configuring-playbook-base-domain-serving.md
- Use common expressions
- Simplify explanation about delegation on docs/configuring-well-known.md and move explanation about the alternative which avoids involving the base domain from that page to its upper documentation, which is docs/howto-server-delegation.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Apply suggestions from code review

Co-authored-by: Slavi Pantaleev <slavi@devture.com>

* Update docs/configuring-dns.md: iterate

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Fix an anchor link to howto-srv-server-delegation.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Minor rewording

* Minor rewording

* Minor rewording

---------

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-16 09:19:17 +02:00
f802df6e6d Update docs/configuring-playbook-federation.md: add note about setting server delegation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-15 18:01:19 +09:00
b94d4d1862 Establish a hierarchy among documentation pages related to installation; ones about importing data and configuring server delegation
This commit clarifies the hierarchy among pages for installation by moving articles for importing data and server delegation under the "installation" section, as there are multiple documentation pages which discuss a similar topic and you can easily get lost in those pages.

Also: remove the anchor link to configuring-playbook-base-domain-serving.md from configuring-playbook.md, since that procedure is not required on configuring options but on finalizing the installation, which is discussed on installing.md after that page.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-15 16:11:44 +09:00
f7d4ffc20c FIx indentation and reword a paragraph on docs/configuring-well-known.md
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3767
2024-11-15 08:38:18 +02:00
04cf09bdb0 Update docs/configuring-well-known.md and docs/installing.md (#3767)
* Update docs/configuring-well-known.md: remove redundant information

For example, anchor links to the headers are distractive as these headers are displayed by scrolling a bit.

Also: edit section headers

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-well-known.md: add "Support service discovery" as a type of well-known service discovery

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-well-known.md: recategorize the sections about installing well-known files on the base domain's server

The commit merges the content of the option 2 with the section above, as both explain how to serve the base domain via the playbook and claim it is the easy way of installing well-known files, and therefore the content is repetitive.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-well-known.md: create a section for types of well-known service discovery mechanism

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-well-known.md: add a link to the Matrix Specification, to which MSC 1929 was implemented

MSC 1929 has no longer been for an early adopter.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-well-known.md: iterate

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-base-domain-serving.md

Co-authored-by: Slavi Pantaleev <slavi@devture.com>

* Update docs/configuring-well-known.md

Co-authored-by: Slavi Pantaleev <slavi@devture.com>

* Update docs/installing.md: iterate

Summary:
- Try to reflect review comments
- Declare that the shorter user identifier is recommended
- Add a note about installing the server matrix.example.com directly, with the link to the FAQ entry

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/installing.md: replace the anchor link to docs/configuring-well-known.md with one to docs/howto-server-delegation.md

Service Discovery via .well-known files is one of the two ways for server delegation, and it is possible to set up server delegation via a DNS SRV record instead (though it is more advanced and complicated), so it should be more proper to use the words "delegation/redirection" than "service discovery".

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-well-known.md: fix a typo

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

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-15 08:34:21 +02:00
91787fc0bd Announce HTTP-compression and timeout adjustments for Traefik-based setups 2024-11-14 17:13:14 +02:00
73e2531293 Update docs/installing.md: add a link to maintenance-migrating.md
The guide is more simple and straightforward.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-10 11:50:20 +09:00
3a11881120 Mention publicly hosted services for Cinny, Element and synapse-admin 2024-11-09 21:18:39 +02:00
61f7f8ff50 Update docs/installing.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-09 17:35:52 +09:00
60dca4dd46 Update docs/installing.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-09 17:33:27 +09:00
6d1b4781c9 Update docs/installing.md: remove the link to itself
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 14:08:27 +09:00
58603d79bc Update docs/installing.md: replace the just recipe with the ansible-playbook 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 <acioustick@noreply.codeberg.org>
2024-11-09 13:53:52 +09:00
5a85bec895 Update docs/installing.md: move example.com base domain
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 12:12:43 +09:00
50d1a8558e Update docs/installing.md: edit the heading "Install Matrix"
Matrix is a name of the protocol and it does not really make sense to install it.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:54:47 +09:00
f8b44a8eca Update docs/installing.md: mention just's "recipe"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:29:09 +09:00
e6b4ffdd93 Update docs/installing.md: add note about making sure of proper installation 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 <acioustick@noreply.codeberg.org>
2024-11-09 03:29:03 +09:00
5e23dee4bb Update docs/installing.md: add missing periods
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:28:57 +09:00
5dccd4e106 Update docs/installing.md: create "Update Ansible roles" section
Also: mention running "just" role on maintainance

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:28:51 +09:00
ea48e5e9eb Create docs/playbook-tags.md: move explanation about playbook tags
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 <acioustick@noreply.codeberg.org>
2024-11-09 03:28:45 +09:00
66a812d99c Update docs/installing.md: remove numbering from headers and links to the headers
Remove nagivations for simplicity.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:28:39 +09:00
578b6b7ab7 Update docs/installing.md: move "Maintaining your setup in the future" under "Things to do next"
Maintenance work by running the playbook will be required after finalizing the installation

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:28:32 +09:00
e02dd88ed0 Update docs/installing.md: add instruction to serve the base domain
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 <acioustick@noreply.codeberg.org>
2024-11-09 03:28:25 +09:00
b61d8f478f Fix capitalization: ids → IDs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 20:31:07 +09:00