Commit Graph

9857 Commits

Author SHA1 Message Date
194a3ca461 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 09:59:29 +02:00
7b6972aea5 Merge pull request #3810 from luixxiul/fix
Update docs/registering-users.md: fix broken anchor links
2024-11-23 07:21:12 +02:00
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
d48890c7a2 Merge pull request #3809 from luixxiul/fix
Replace the warning emoji in text style (U+26A0 FE0E) to emoji style (U+26A0 FE0F)
2024-11-22 21:22:28 +02: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
f1712cec73 Merge pull request #3806 from luixxiul/fix
Add .github/workflows/close-stale-issues.yml: close stale issues automatically
2024-11-22 08:29:30 +02:00
b8ed31527c Add .github/workflows/close-stale-issues.yml: close stale issues automatically
With this commit, actions/stale on GitHub will add a label 'stale' on issues (on spantaleev/matrix-docker-ansible-deploy) after 60 days of inactivity and close the stale issues after 7 days of inactivity. Only issues with labels 'question' and/or 'needs-info' will be processed, and ones with a label 'confirmed' will not be processed automatically.

Please refer https://github.com/marketplace/actions/close-stale-issues

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-22 13:57:29 +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
659b7a000b Merge pull request #3802 from spantaleev/renovate/traefik-3.x
Update dependency traefik to v3.2.1-0
2024-11-21 11:52:50 +02:00
67070f6951 Update dependency traefik to v3.2.1-0 2024-11-21 09:14:31 +00: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
ccd6c003ab Synapse Admin v0.10.3-etke31
https://github.com/etkecc/synapse-admin/releases/tag/v0.10.3-etke31
2024-11-21 08:13:07 +02:00
9b72852afe updated backup_borg (v1.4.0-1.9.2-0 -> v1.4.0-1.9.2-1); 2024-11-20 23:10:08 +02:00
66febbcd72 Merge pull request #3800 from spantaleev/renovate/docker-7.x
Update dependency docker to v7.4.2
2024-11-20 19:44:29 +02:00
caef30064a Update dependency docker to v7.4.2 2024-11-20 17:42:42 +00:00
d0d563138e Merge pull request #3798 from spantaleev/renovate/docker.io-metio-matrix-alertmanager-receiver-2024.x
Update docker.io/metio/matrix-alertmanager-receiver Docker tag to v2024.11.20
2024-11-20 09:31:08 +02:00
5645ec0eda Update docker.io/metio/matrix-alertmanager-receiver Docker tag to v2024.11.20 2024-11-20 07:25:22 +00:00
ef8581e323 Upgrade Postgres (v17.0-1 -> v17.0-2) 2024-11-20 09:24:43 +02:00
b363c17cd9 updated backup_borg (v1.4.0-1.9.1-0 -> v1.4.0-1.9.2-0); updated grafana (v11.3.0-0 -> v11.3.1-0); 2024-11-19 23:31:39 +02:00
bccdcbe19b Upgrade baibot (v1.3.2 -> v1.4.0) 2024-11-19 22:47:14 +02:00
373b158f75 Merge pull request #3797 from spantaleev/renovate/vectorim-element-web-1.x
Update vectorim/element-web Docker tag to v1.11.86
2024-11-19 20:23:31 +02:00
2008b8595b Update vectorim/element-web Docker tag to v1.11.86 2024-11-19 17:41:04 +00:00
44cc2afc11 Merge pull request #3793 from luixxiul/fix
Edit docs/prerequisites.md: create categories for required software on the server and the local computer
2024-11-18 13:01:51 +02:00
769a31d3ca adjust synapse purge jobs template 2024-11-18 10:00:12 +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
3b0a433ec8 Merge pull request #3792 from luixxiul/fix
Update docs/registering-users.md: remove a section for recommending delegation
2024-11-18 07:40:02 +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
ba0ef316cc Merge pull request #3791 from luixxiul/fix
Update docs/registering-users.md: add details about delegation
2024-11-17 21:34:43 +02:00
7fc8509f04 synapse - update retention purge jobs template 2024-11-17 18:34:22 +02: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
fa85ba28dd Merge pull request #3788 from luixxiul/fix
Fix broken anchor links
2024-11-17 14:42:25 +02:00
5e4c930d90 Fix broken anchor links
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 21:30:47 +09:00
8078a743e2 Merge pull request #3787 from luixxiul/fix
Update docs/configuring-playbook-bridge-hookshot.md: fix link to main.yml
2024-11-17 14:14:40 +02:00
5bf09f5fdc add new variables to control message retention in Synapse 2024-11-17 13:47:06 +02: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
8f9dfdee4e Merge pull request #3785 from luixxiul/fix
Edit docs/configuring-playbook-client-schildichat-web.md
2024-11-17 09:43:57 +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
e5c4650cf8 Merge pull request #3783 from luixxiul/fix
Change "Configuring your DNS server" to "Configuring your DNS settings"
2024-11-17 08:42:33 +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