* 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>
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>
* Rename variables matrix_bot_postmoogle_* with matrix_postmoogle_*
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename file names and references to those files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Move variables block for /matrix-bridge-postmoogle
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename matrix_playbook_bot_postmoogle_ to matrix_playbook_bridge_postmoogle_
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add matrix_playbook_migration_matrix_postmoogle_migration_validation_enabled
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace an install tag example with "-bot" prefix
The previous example seems to have been selected to show how components whose name contains "-bot-" needed to be specified.
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>
* rewrite `just update` command to provide a one-line command to update everything
* update prefix
* uncomment update-self
* Revert requirements.yml updates not belonging to this PR
* Justfile and documentation updates to make things clearer
---------
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
We no longer ask users to create Matrix user accounts for these bots:
- Postmoogle
- Honoroit
- Reminder Bot
Other bots and services (matrix-registration-bot, maubot, mjolnir,
Dimension, etc.) require an Access Token to run (not a password),
so this new role doesn't help for them.
It does help for the above bots though, and for defining your own
"initial user accounts" in the `matrix_user_creator_users_additional`
variable.
Since we'll likely have generic SQLite database importing
via [pgloader](https://pgloader.io/) for migrating bridge
databases from SQLite to Postgres, we'd rather avoid
calling the "import Synapse SQLite database" command
as just `--tags=import-sqlite-db`.
Similarly, for the media store, we'd like to mention that it's
related to Synapse as well.
We'd like to be more explicit, so as to be less confusing,
especially in light of other homeserver implementations
coming in the future.
This flag is necessary for Ansible to ask for the sudo password when using the non-root option as documented in the `hosts` file. Otherwise, Ansible errors out with `missing sudo password`.
This is a simplification and a way to make it consistent with
how we do Postgres imports (see 6d89319822), using
files coming from the server, not from the local machine.
By encouraging people NOT to use local files,
we potentially avoid problems such as #34 (Github issue),
where people would download `media_store` to their Mac's filesystem
and case-sensitivity issues will actually corrupt it.
By not encouraging local files usage, it's less likely that
people would copy (huge) directories to their local machine like that.
