Commit Graph

10049 Commits

Author SHA1 Message Date
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
7a77d84276 synapse-admin: get rid of lookup and config duplicate var 2024-11-08 18:47:37 +02:00
28a4434f55 Document why matrix_synapse_admin_well_known_client_configuration duplicates matrix_synapse_admin_configuration (roles/custom/matrix-synapse-admin/templates/config.json.j2) 2024-11-08 18:34:50 +02:00
30efde4ed3 add missing synapse-admin config options to /.well-known/matrix/client 2024-11-08 18:04:01 +02:00
0cb3e530d9 Add support for auto-configuring synapse-admin via /.well-known/matrix/client
Related to:
- https://github.com/etkecc/synapse-admin/pull/126
- https://github.com/etkecc/synapse-admin/releases/tag/v0.10.3-etke27

People who wish to disable this and keep their `/.well-known/matrix/client` file tidier
can do it via:

```yml
matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_enabled: false
```
2024-11-08 17:48:37 +02:00
260421beb1 Merge pull request #3760 from luixxiul/fix
Edit the note about "matrix_homeserver_implementation" variable
2024-11-08 17:02:45 +02:00
3c34418ebe Edit the note about "matrix_homeserver_implementation" variable
Since a casual user might want to try another homeserver than Synapse without thinking about its consequence, it is important to clarify that it is not possible to switch homeservers once specified.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 23:59:14 +09:00
885b8e9204 Merge pull request #3759 from luixxiul/fix
Fix capitalization: element, ids, riot
2024-11-08 16:21:37 +02:00
2fcd824d6b Fix capitalization: riot → Riot
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 20:36:35 +09:00
b61d8f478f Fix capitalization: ids → IDs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 20:31:07 +09:00
3af7355d14 Fix capitalization: element → Element
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 20:30:59 +09:00
fcf3755f9c Merge pull request #3758 from luixxiul/fix
Update docs/container-images.md: use emoji
2024-11-08 10:28:24 +02:00
73a30375fa Improve readability - configuring-playbook-own-webserver.md (#3751)
* Improve readability -  configuring-playbook-own-webserver.md

* Update docs/configuring-playbook-own-webserver.md

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>

---------

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>
2024-11-08 10:20:06 +02:00
d8cacb9cde Update docs/container-images.md: use emoji
Follow-up to 1a87f92647.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 13:25:00 +09:00
f4eada6f10 Merge pull request #3756 from luixxiul/fix
Update docs/configuring-playbook-sliding-sync-proxy.md: Element X is no longer beta
2024-11-07 20:43:46 +02:00
02a2b4d4d1 Update docs/configuring-playbook-sliding-sync-proxy.md: Element X is no longer beta
Since 2023-09-21, Element X is no longer beta. See https://element.io/blog/element-x-ignition/

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 00:18:28 +09:00
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
8308a91afa synapse-admin v0.10.3-etke29 2024-11-07 13:05:09 +02:00
513320199a Merge pull request #3754 from spantaleev/add-oembed-var
add matrix_synapse_oembed_additional_providers var
2024-11-07 11:10:32 +02:00
95aaf76d0d add matrix_synapse_oembed_additional_providers var 2024-11-07 11:08:40 +02:00
fc2f09d124 another aux role update 2024-11-07 10:56:24 +02:00
fa2ba3e04c Update aux role 2024-11-07 09:47:31 +02:00
da181d72f0 Merge pull request #3752 from spantaleev/renovate/prometheus-2.x
Update dependency prometheus to v2.55.1-0
2024-11-06 14:07:33 +02:00
1da02aee3d Update dependency prometheus to v2.55.1-0 2024-11-06 11:08:07 +00:00
1a87f92647 Emojify main README
✓ and x indicators provide less visibility, as they're very similarly
looking.

Emojis (especially when colored) make it much easier to see which
component is a default one and which isn't.

Section headings are also prefixed with an emoji now to make
decrease the "wall of text" feeling.
2024-11-06 09:24:46 +02:00
db57c95cc0 Remove redundant Installation section from main README
Superseded by the new "Getting started" section, which is higher up and
gets more visibility.
2024-11-06 09:17:55 +02:00
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
40d1a526b1 Merge pull request #3750 from spantaleev/renovate/vectorim-element-web-1.x
Update vectorim/element-web Docker tag to v1.11.84
2024-11-05 18:30:13 +02:00
261b5dee07 Update vectorim/element-web Docker tag to v1.11.84 2024-11-05 16:25:11 +00:00
8b9833bfd2 Merge pull request #3747 from luixxiul/fix
Update docs/configuring-dns.md and docs/prerequisites.md: add the common horizontal line
2024-11-05 15:41:56 +02:00
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
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
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
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
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
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
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
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
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
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
b9b37f34e1 Merge pull request #3743 from mitjajez/patch-1
Update installing.md
2024-11-04 19:57:55 +02:00
d817a923a3 Update installing.md
I believe this is typo.
2024-11-04 18:21:46 +01:00
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
d689a73f93 update backup-borg role 2024-11-04 14:17:44 +02:00