Commit Graph

36 Commits

Author SHA1 Message Date
Suguru Hirahara
e8548e0016
Mention how much "just install-all" is faster than "just setup-all"
This way, the "installing" sections would cover from beginners to advanced (professional) readers.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-02 20:00:58 +09:00
Suguru Hirahara
bc1849d7ff
Edit installing instructions (#3844)
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all"

Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible.

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

* Edit installing instructions

- Move the anchor links to docs/just.md
- Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start"

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

* Update descriptions about installation

- Introduce the most conservative and stable raw ansible-playbook command.
- Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts.

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

* Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created

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-12-01 17:04:54 +02:00
Suguru Hirahara
20c2aade3e
Edit descriptions about installation of components (#3842)
* Replace installation command shortcut for the "just" program with the most conservative raw ansible-playbook command

This commit replaces installation command shortcut ("recipe") for the "just" program with the raw ansible-playbook command, so that the shortcut will be added to it later. The command is so conservative that failure of the command will mean something is clearly broken.

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

* Add comments about using setup-all instead of install-all

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

* Add description about shortcut command with the "just" program to the ansible-playbook command with "setup-all" and "start" tags

It also explains difference between "just install-all" and "just setup-all" recipes. The explanation is based on docs/playbook-tags.md

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

* Update raw ansible-playbook command to have it do what "just install-all" or "just setup-all" does

Since "just install-all" or "just setup-all" invokes "ensure-matrix-users-created" as well, it needs adding to the raw ansible-playbook command.

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

* Remove "ensure-matrix-users-created" from the raw ansible-playbook command which does not need it

Also: update the "just" recipes accordingly. "just install-all" and "just setup-all" run "ensure-matrix-users-created" tag as well, therefore they need to be replaced with "run-tags" recipes to skip "ensure-matrix-users-created"

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

* Update docs/configuring-playbook-etherpad.md: add ensure-matrix-users-created to the raw ansible-playbook

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

* Add description about "ensure-matrix-users-created" and create a list with description about shortcut commands with "just"

This commit also fixes list item capitalization and punctuation.

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

* Add notes bullet lists

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

* Update docs/configuring-playbook-matrix-corporal.md and docs/configuring-playbook-email2matrix.md: adopt common instructions

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

* Replace "run the installation command" with "run the playbook with tags"

Now that shortcut commands for the "just" program are displayed along with the existing "installation command", this commit replaces "run the installation command" with "run the playbook with tags" in order to prevent misunderstanding and confusion.

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

* Add notes about changing passwords of users specified on vars.yml

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

* Update docs/configuring-playbook-synapse-admin.md: add the playbook command and just recipes

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

* Remove redundant blank lines

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

* Update docs/configuring-playbook-alertmanager-receiver.md: remove the direction to proceed to Usage

Such a kind of direction is not used on other documentation, so it should be fine to just remove it.

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

* Update docs/importing-synapse-media-store.md: code block for ansible-playbook

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-12-01 09:42:30 +02:00
Suguru Hirahara
45352e76ce
Apply the common documentation style (#3840)
* Update docs/configuring-playbook-bridge-appservice-webhooks.md: apply the common documentation style

Since the bridge has been deprecated, this change is simply intended to improve styling and format of the article in case it will be used as a template of another bridge in a future.

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

* Update docs/configuring-playbook-bridge-appservice-discord.md: apply the common documentation style

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

* Update docs/configuring-playbook-bridge-appservice-slack.md: apply the common documentation style

Also: move instruction to create Classic Slack application up as prerequisite

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

* Update docs/configuring-playbook-bridge-appservice-slack.md: emphasize the unavailability without a classic Slack application

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-29 17:52:28 +02:00
Suguru Hirahara
ae864830e0
Update the URL to matrix-appservice-discord
The URL seems to have been changed at least since several years though the exact date is unknown to me, considering the latest tagged docker image on https://hub.docker.com/r/halfshot/matrix-appservice-discord/tags (https://hub.docker.com/layers/halfshot/matrix-appservice-discord/develop/images/sha256-a1015907545603448d2d8e2ea0d31f0fdb6c7676009e2cb38e324440a9284317) is dated Feb 15, 2021.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 17:18:03 +09:00
Suguru Hirahara
3d47e0d69c
Synchronize document titles and links based on configuring-playbook.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-26 21:28:31 +09:00
Suguru Hirahara
082b75b0c0
Fix indentations of list items
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 17:15:10 +09:00
Suguru Hirahara
54e84c5c73
Update docs/configuring-playbook-bridge-appservice-discord.md
Fix a typo

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 16:27:18 +09:00
Suguru Hirahara
aaa6335053
Replace !someRoom with !qporfwt
!qporfwt is used as an example of a room ID on https://spec.matrix.org/v1.12/#room-structure

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:47:52 +09:00
Suguru Hirahara
1e8030810f
Update internal room ID: !someRoom
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:47:02 +09:00
Suguru Hirahara
65967dd52e
Replace :SERVER with :example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:42:56 +09:00
Suguru Hirahara
59dd889671
Replace <example.com> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:26:47 +09:00
Suguru Hirahara
0261e247e3
Replace YOUR_DOMAIN with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:26:23 +09:00
Suguru Hirahara
a8ab53c149
Use double wildcards for 'Note'
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-15 03:05:26 +09:00
Suguru Hirahara
789bf88b92
Make "Note" consistent: wrap with wildcards
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-15 02:48:46 +09:00
blotree
0c88408bb7
Update docs for older appservice bridges to enable legacy authorization (#2841)
* Update docs for older appservice bridges to enable legacy authorization

* Update docs/configuring-playbook-bridge-appservice-discord.md

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

* Update docs/configuring-playbook-bridge-appservice-webhooks.md

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

* further fix formatting

---------

Co-authored-by: blotree <teruyo@touhou-project.com>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2023-08-25 15:53:28 +03:00
JokerGermany
27effa0274 enumeration for better visibility 2022-08-02 12:22:41 +02:00
JokerGermany
2e330e7fe0 fixing links, adding paragraph 2022-08-02 12:18:41 +02:00
JokerGermany
52f8ee618b specify discord bridge usage; fix links 2022-08-02 11:25:29 +02:00
Slavi Pantaleev
fdc9fb9d50 Improve mautrix-discord docs
Related to:

- https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1974
- https://github.com/mautrix/discord/issues/17
- https://github.com/mautrix/discord/issues/18
- https://github.com/mautrix/discord/issues/19
2022-07-29 20:17:52 +03:00
Slavi Pantaleev
9d10d5543b Announce mautrix-discord support 2022-07-29 08:10:09 +03:00
Jim Myhrberg
620e3b1b0d
docs(appservice-discord): improve and expand bridging method docs 2022-03-06 01:56:24 +00:00
Slavi Pantaleev
d9bf2f59db Fix adminme.js usage for matrix-appservice-discord (still hacky)
Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/795
and https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/822

A better fix will come later: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/825
2021-01-25 15:36:08 +02:00
Slavi Pantaleev
db69a51653 Do not recommend usePrivilegedIntents for appservice-discord
We're getting reports of it being broken and I can confirm that the
bridge works well without it, so I don't see why we'd be asking
people to enable it.

Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/751
2020-12-16 16:26:15 +02:00
Slavi Pantaleev
6dbb90258e Mention and recommend enabling usePrivilegedIntents 2020-11-13 08:23:40 +02:00
Slavi Pantaleev
4ef873ceb0 Clarify Discord bridging docs 2020-09-03 16:31:27 +03:00
Slavi Pantaleev
76352bcbd8 Announce mx-puppet-discord bridging support
Related to #540 (Github Pull Request).
2020-07-01 19:01:14 +03:00
Slavi Pantaleev
e48cfa4bcc Improve documentation on joining Discord rooms 2020-06-09 08:02:13 +03:00
Slavi Pantaleev
b450afc12e Make Discord bridge docs better 2020-04-01 11:34:53 +03:00
Slavi Pantaleev
bb2b2b4f1c Clarify Discord bridging docs 2020-03-31 11:13:45 +03:00
Slavi Pantaleev
584418ae0f Fix broken link 2020-03-31 10:30:07 +03:00
Slavi Pantaleev
8529efcd1c Make Discord bridge configuration playbook-managed
Well, `config.yaml` has been playbook-managed for a long time.
It's now extended to match the default sample config of the Discord
bridge.

With this patch, we also make `registration.yaml` playbook-managed,
which leads us to consistency with all other bridges.

Along with that, we introduce `./config` and `./data` separation,
like we do for the other bridges.
2019-06-26 10:35:00 +03:00
Slavi Pantaleev
401d7560e9 Make Discord bridging instructions more detailed
It didn't mention `matrix_appservice_discord_client_id` and
`matrix_appservice_discord_bot_token`, which makes it hard for
beginners.

Related to #105 (Github Pull Request).
2019-03-05 09:10:32 +02:00
Lionstiger
b5ae0254fd used ` backticks instead of double quotes 2019-03-04 14:41:58 +01:00
Lionstiger
faa16617da add documentation 2019-03-03 19:34:30 +01:00
Lionstiger
835c349275 Add matrix-appservice-discord bridge
Bridge is setup to work on the matrix side with this, but the discord invite link is not automatically generated.
2019-03-03 18:22:52 +01:00