Commit Graph

8512 Commits

Author SHA1 Message Date
Suguru Hirahara
3684e93a61
Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation (#3745)
* 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>
2024-11-05 14:38:26 +02:00
Slavi Pantaleev
eb452b4e3e
Merge pull request #3744 from luixxiul/fix
Update docs/configuring-dns.md: remove an incorrect instruction to the next step
2024-11-05 10:43:29 +02:00
Slavi Pantaleev
c8c83252be Add "Getting started" section to main README
We were linking to the "guided installation" even now, but there are so
many links and no explicit "Getting started" link anywhere.
This tries to make things better.

Inspired by:

- https://news.ycombinator.com/item?id=42039447
- https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3744
2024-11-05 10:39:05 +02:00
Slavi Pantaleev
9e5bb8629c Move sliding-sync proxy Note to the top of its docs page
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
2024-11-05 09:46:02 +02:00
Slavi Pantaleev
4cd4835888 De-emphasize the old sliding-sync proxy further
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3735
2024-11-05 09:41:16 +02:00
1over137
065d3ac066
Documentation: sliding sync proxy is not required for Synapse >1.114 (#3735)
* Update configuring-playbook-sliding-sync-proxy.md

* Update README.md

* Apply suggestions from code review

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

---------

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-05 09:37:11 +02:00
Slavi Pantaleev
c720e9531c Upgrade backup-borg (v1.4.0-1.9.0-1 -> v1.4.0-1.9.0-2) 2024-11-05 09:06:32 +02:00
Suguru Hirahara
bb84d6f70a
Update docs/configuring-dns.md: remove an incorrect instruction to the next step
The right next step of docs/configuring-dns.md is docs/getting-the-playbook.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-05 11:58:23 +09:00
Aine
68342eda10
Merge pull request #3742 from luixxiul/fix
Update docs/installing.md: add a note to avoid running the just recipe install-all, instead of ansible-playbook with install-all tag
2024-11-04 19:58:24 +02:00
Aine
b9b37f34e1
Merge pull request #3743 from mitjajez/patch-1
Update installing.md
2024-11-04 19:57:55 +02:00
Mitja Jež
d817a923a3
Update installing.md
I believe this is typo.
2024-11-04 18:21:46 +01:00
Suguru Hirahara
4bd511819f
Update docs/installing.md: add a note to avoid running the just recipe install-all, instead of ansible-playbook with install-all tag
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>
2024-11-04 23:00:25 +09:00
Aine
d689a73f93
update backup-borg role 2024-11-04 14:17:44 +02:00
Aine
bcc6c4022d
Merge pull request #3740 from spantaleev/renovate/backup_borg-1.x
Update dependency backup_borg to v1.4.0-1.9.0-0
2024-11-04 12:38:38 +02:00
renovate[bot]
cc3641d7c0
Update dependency backup_borg to v1.4.0-1.9.0-0 2024-11-04 10:21:44 +00:00
Slavi Pantaleev
71b00a817d
Merge pull request #3738 from luixxiul/fix
Update documentation related to FAQ
2024-11-04 10:47:23 +02:00
Slavi Pantaleev
a2d193f163 Upgrade Traefik (v3.1.3-3 -> v3.2.0-0) 2024-11-04 10:30:52 +02:00
Slavi Pantaleev
6b83f00f8e Upgrade Traefik (v3.1.3-2 -> v3.1.3-3) 2024-11-04 10:28:09 +02:00
Suguru Hirahara
79680c5ac1
Update i-need-help.md: add notification about FAQ.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-04 16:27:47 +09:00
Suguru Hirahara
ae4dd1ea3a
Update docs/faq.md: fix headings level
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-04 16:27:39 +09:00
Slavi Pantaleev
970ae997b6
Merge pull request #3736 from ikkemaniac/patch-1
improve readability configuring-dns.md
2024-11-04 08:31:27 +02:00
Slavi Pantaleev
08a19ac4ee
Merge pull request #3737 from luixxiul/fix
Update README.md and docs/container-images.md
2024-11-04 08:13:40 +02:00
Suguru Hirahara
7b9aaceb7e
Update README.md and docs/container-images.md: move "synapse-simple-antispam" to Authentication, following docs/configuring-playbook.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-04 13:11:37 +09:00
Suguru Hirahara
c8ee67aa3b
Update README.md and docs/container-images.md: move up Exim as default service
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-04 13:10:26 +09:00
ikkemaniac
7864a75607
improve readability configuring-dns.md 2024-11-03 21:08:10 +01:00
Slavi Pantaleev
8078a8ad2e
Merge pull request #3734 from luixxiul/fix
Update docs/configuring-playbook.md: adopt the same structure and order for entries as ones on README.md
2024-11-03 21:08:42 +02:00
Suguru Hirahara
68b8f1137f
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section
These sentences are copied from README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:43:06 +09:00
Suguru Hirahara
16104b6e57
Update docs/configuring-playbook.md: move entries to "Other specialized services" section
These entries are ones categorized under "Misc" section on README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:41:59 +09:00
Suguru Hirahara
69273b30e4
Update docs/configuring-playbook.md: create "Administration" section
Reorganize "Additional useful services" section and "Other specialized services" section

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:39:54 +09:00
Suguru Hirahara
d630668f46
Update docs/configuring-playbook.md: move "Additional useful services" section down under "Bots" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:38:45 +09:00
Suguru Hirahara
2376821722
Update docs/configuring-playbook.md: create "File Storage" section under "Authentication and user-related" section
This basically follows the order of the tables on README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:37:59 +09:00
Suguru Hirahara
eaeb2f99b5
Update docs/configuring-playbook.md: move "Authentication and user-related" section up
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:37:40 +09:00
Suguru Hirahara
15fd33fb45
Update docs/configuring-playbook.md: merge "Server connectivity" section to "Core service adjustments" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:37:13 +09:00
Suguru Hirahara
c404995456
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md
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>
2024-11-03 19:34:41 +09:00
Suguru Hirahara
7511b3d3ea
Update docs/configuring-playbook.md: create a section "Clients"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:32:59 +09:00
Suguru Hirahara
6e92a5da3f
Update docs/configuring-playbook.md: move "Core service adjustments" section up
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:32:03 +09:00
Slavi Pantaleev
22ef4aed3c
Merge pull request #3732 from luixxiul/fix
Update docs/configuring-playbook.md: remove "optional" from links
2024-11-03 11:29:59 +02:00
Suguru Hirahara
55d9aa04c2
Update docs/configuring-playbook.md: remove "optional" from links
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>
2024-11-03 17:07:43 +09:00
Slavi Pantaleev
4a5243228c
Merge pull request #3731 from luixxiul/fix
Fix capitalization: draupnir → Draupnir
2024-11-03 09:57:12 +02:00
Suguru Hirahara
5ef203777f
Fix capitalization: draupnir → Draupnir
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 16:53:01 +09:00
Slavi Pantaleev
b3f3fca295
Merge pull request #3730 from luixxiul/fix
Update docs/updating-users-passwords.md
2024-11-03 08:11:34 +02:00
Suguru Hirahara
1886a8fc4d
Update docs/updating-users-passwords.md: fix SQL command
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 12:54:15 +09:00
Suguru Hirahara
f8c9507ae1
Update docs/updating-users-passwords.md: triple backticks for syntax highlighting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 12:53:35 +09:00
Slavi Pantaleev
9a9b913bc5
Merge pull request #3727 from luixxiul/fix
Update docs/configuring-playbook-bridge-appservice-webhooks.md
2024-11-02 21:41:31 +02:00
Suguru Hirahara
c6f0b290bc
Update docs/configuring-playbook-bridge-appservice-webhooks.md
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>
2024-11-03 01:59:26 +09:00
Suguru Hirahara
fd1d3e6bfc
Update docs/configuring-playbook-backup-borg.md (#3724)
* Update docs/configuring-playbook-backup-borg.md

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

* Reflect the feedback

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-02 17:38:06 +02:00
Slavi Pantaleev
f8ef45a9a3
Merge pull request #3725 from spantaleev/renovate/joseluisq-static-web-server-2.x
chore(deps): update joseluisq/static-web-server docker tag to v2.33.1
2024-11-02 16:46:17 +02:00
renovate[bot]
af992fb43b
chore(deps): update joseluisq/static-web-server docker tag to v2.33.1 2024-11-02 13:38:33 +00:00
Slavi Pantaleev
34f9cd9435
Merge pull request #3723 from spantaleev/renovate/ghcr.io-etkecc-postmoogle-0.x
chore(deps): update ghcr.io/etkecc/postmoogle docker tag to v0.9.24
2024-11-02 11:24:24 +02:00
renovate[bot]
2ac89b7fb2
chore(deps): update ghcr.io/etkecc/postmoogle docker tag to v0.9.24 2024-11-02 09:23:23 +00:00