Commit Graph

1506 Commits

Author SHA1 Message Date
Suguru Hirahara
b04b658735
Add "Web" to Element and SchildiChat web application (#3755)
* 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>
2024-11-07 16:31:26 +02:00
Suguru Hirahara
1b4fa79595
Update docs/registering-users.md: add configuration for enabling public user registration on Dendrite (#3748)
* 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>
2024-11-05 19:30:03 +02:00
Suguru Hirahara
0a2198f754
Update docs/configuring-dns.md and docs/prerequisites.md: add the common horizontal line
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-05 22:30:21 +09:00
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
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
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
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
Slavi Pantaleev
71b00a817d
Merge pull request #3738 from luixxiul/fix
Update documentation related to FAQ
2024-11-04 10:47:23 +02: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
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
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
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
Suguru Hirahara
5ef203777f
Fix capitalization: draupnir → Draupnir
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 16:53:01 +09: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
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
Suguru Hirahara
018a8c8fdf
Update docs/configuring-playbook-s3.md: replace the URL to matrix-media-repo
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>
2024-11-02 18:16:29 +09:00
Suguru Hirahara
6b5c66675a
Update docs/configuring-playbook-backup-borg.md and docs/configuring-playbook-ntfy.md: fix URLs
Remove "/-/" from the URLs, which is a fragment of URLs on GitLab

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-02 17:56:56 +09:00
Suguru Hirahara
24ab56b1bc
Update docs/container-images.md: create a table for deprecated or unmaintained services
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:52 +09:00
Suguru Hirahara
c2859c727c
Update docs/container-images.md: create a table for Misc
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:48 +09:00
Suguru Hirahara
a4619fec25
Update docs/container-images.md: create a table for Administration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:44 +09:00
Suguru Hirahara
292dd56eed
Update docs/container-images.md: create a table for Bots
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:39 +09:00
Suguru Hirahara
2b12ccb517
Update docs/container-images.md: create a table for Bridges
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:34 +09:00
Suguru Hirahara
d90dcc4a04
Update docs/container-images.md: create a table for File Storage
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:29 +09:00
Suguru Hirahara
ab1cce5a14
Update docs/container-images.md: create a table for Authentication
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:25 +09:00
Suguru Hirahara
f3fde12c45
Update docs/container-images.md: create tables for Clients and Server Components
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:20 +09:00
Suguru Hirahara
63e16ed034
Update docs/container-images.md: create a table for Homeserver
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>
2024-11-01 22:33:44 +09:00
Suguru Hirahara
8f7a723b37
Update docs/configuring-playbook-bridge-mautrix-meta-instagram.md: the same paragraph as docs/configuring-playbook-bridge-mautrix-meta-messenger.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 21:59:20 +09:00
Suguru Hirahara
f5e333b513
Update docs/configuring-playbook-bridge-mautrix-meta-messenger.md: add a note about user ID of the new bridge's bot
The user ID of the new bridge (mautrix-meta) is different from that of the old bridge (mautrix-facebook). It is slightly confusing, and the note should help migration.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 21:53:28 +09:00
Suguru Hirahara
0bc4ef8f4d
Update documentation titles of deprecated or unmaintained services
Also: fix typos

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 17:31:53 +09:00
Suguru Hirahara
e9c5562ae7
Fix anchor links and its title of documents related to Amazon S3
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 16:37:41 +09:00
Suguru Hirahara
76099c8936
Update docs/configuring-playbook-s3.md about object storage providers
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 16:37:19 +09:00