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>
* 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>
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>
* 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>
* 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>
Essentially it means "configuring your DNS settings or records on the DNS server you use".
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
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>
* 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>
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>
* 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>
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>
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>
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>
Maintenance work by running the playbook will be required after finalizing the installation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
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>
* Replace "Element" with "Element Web"
- If Element indicates the web application, then it is changed to Element Web.
- If it indicates clients branded with Element such as Element desktop, web, mobile clients, then it is changed to Element clients.
- If it is combined with location sharing functionality, it is not changed.
with other some changes, including:
- Change "app.element.io" anchor link to "https://github.com/element-hq/element-web" on README.md, following other documentation files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "SchildiChat" with "SchildiChat Web"
- If SchildiChat indicates the web application, then it is changed to SchildiChat Web.
- If it indicates clients branded with SchildiChat such as SchildiChat desktop, web, mobile clients, then it is changed to SchildiChat clients.
- If it is combined with location sharing functionality, it is not changed.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename configuring-playbook-client-schildichat.md to configuring-playbook-client-schildichat-web.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename configuring-playbook-client-element.md to configuring-playbook-client-element-web.md
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>
* Update docs/registering-users.md: add configuration for enabling public user registration on Dendrite
Per the suggestion on https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2545
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Set matrix_dendrite_client_api_registration_disabled to false
Mind "matrix_synapse_enable_registration" for Synapse is set to false by default.
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>
* Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation
Since it is easy to get lost among these files, the breadcrumbs should be helpful to get the whole picture of the procedure. Hopefully they will be replaced with something else generated automatically.
Please note that the usage of <sup> HTML tags on this context is not proper as the tag is intended to be used only for typographical reasons. Here <small> tags should rather be used instead as long as we do not use CSS, but since GitHub strips these tags against its spec (https://github.github.com/gfm/#disallowed-raw-html-extension-) (also note: the <small> HTML tags are not stripped on Codeberg for example), this commit intentionally uses <sup> to have those breadcrumbs rendered in small points.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook.md title
The file is referred from other files as "Configuring the playbook"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add "Quick start" link with the thunder icon
For now docs/README.md is linked
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>
People should be made aware of the status of this component as soon as
possible.
This is consitent with the positioning of Note messages we have for other deprecated
components (e.g. bot-chatgpt, bot-go-neb, etc).
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3735
The note is for those who are not familiar with the playbook's tag and its just recipe.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Also: update README.md and docs/container-images.md
Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Use a common expression for adjusting configuration. As the component has been deprecated, this is purely for future use as a template.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
The URL stopped working since some time. Linking to the internal file will keep working as long as the URL is properly managed.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This is essentially an imitation of 59a01dabfc for container images. It copies the entries order and descriptions on the table of README.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
