From 6b87d1aa7d24ce99578a252317670c80e4891be2 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 22 Dec 2024 14:59:40 +0900 Subject: [PATCH] Edit docs: consistent instructions to generate passphrases or secrets with pwgen This commit replaces instructions to create passwords, passphrases, or secrets with common ones. Signed-off-by: Suguru Hirahara --- CHANGELOG.md | 2 +- docs/configuring-playbook-alertmanager-receiver.md | 2 +- docs/configuring-playbook-backup-borg.md | 2 +- docs/configuring-playbook-bot-baibot.md | 4 ++-- docs/configuring-playbook-bot-buscarron.md | 2 +- docs/configuring-playbook-bot-chatgpt.md | 2 +- docs/configuring-playbook-bot-draupnir.md | 2 +- docs/configuring-playbook-bot-go-neb.md | 2 +- docs/configuring-playbook-bot-honoroit.md | 2 +- docs/configuring-playbook-bot-matrix-registration-bot.md | 2 +- docs/configuring-playbook-bot-matrix-reminder-bot.md | 2 +- docs/configuring-playbook-bot-maubot.md | 2 +- docs/configuring-playbook-bot-mjolnir.md | 2 +- docs/configuring-playbook-bridge-postmoogle.md | 2 +- docs/configuring-playbook-matrix-registration.md | 2 +- docs/configuring-playbook-shared-secret-auth.md | 2 +- examples/vars.yml | 2 +- 17 files changed, 18 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9cd25b0ab40..a127deb136c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2192,7 +2192,7 @@ To migrate to the new setup, expect a few minutes of downtime, while you follow 1. We believe the steps below are safe and you won't encounter any data loss, but consider [making a Postgres backup](docs/maintenance-postgres.md#backing-up-postgresql) anyway. If you've never backed up Postgres, now would be a good time to try it. -2. Generate a strong password to be used for your superuser Postgres user (called `matrix`). You can use `pwgen -s 64 1` to generate it, or some other tool. The **maximum length** for a Postgres password is 100 bytes (characters). Don't go crazy! +2. Generate a strong password to be used for your superuser Postgres user (called `matrix`). You can create one with a command like `pwgen -s 64 1`. The **maximum length** for a Postgres password is 100 bytes (characters). Don't go crazy! 3. Update your playbook's `inventory/host_vars/matrix.example.com/vars.yml` file, adding a line like this: ```yaml diff --git a/docs/configuring-playbook-alertmanager-receiver.md b/docs/configuring-playbook-alertmanager-receiver.md index 078b7be17aa..08aca3d547a 100644 --- a/docs/configuring-playbook-alertmanager-receiver.md +++ b/docs/configuring-playbook-alertmanager-receiver.md @@ -14,7 +14,7 @@ This service uses a bot (with a username specified in `matrix_alertmanager_recei The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot. -Choose a strong password for the bot. You can generate a good password with a command like this: `pwgen -s 64 1`. +Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. You can use the playbook to [register a new user](registering-users.md): diff --git a/docs/configuring-playbook-backup-borg.md b/docs/configuring-playbook-backup-borg.md index fc933d9e20d..dba51e9053d 100644 --- a/docs/configuring-playbook-backup-borg.md +++ b/docs/configuring-playbook-backup-borg.md @@ -60,7 +60,7 @@ where: * USER - SSH user of a provider/server * HOST - SSH host of a provider/server * REPO - BorgBackup repository name, it will be initialized on backup start, eg: `matrix`, regarding Syntax see [Remote repositories](https://borgbackup.readthedocs.io/en/stable/usage/general.html#repository-urls) -* PASSPHRASE - passphrase used for encrypting backups, you may generate it with `pwgen -s 64 1` or use any password manager +* PASSPHRASE - passphrase used for encrypting backups. You can create one with a command like `pwgen -s 64 1`. * PRIVATE KEY - the content of the **private** part of the SSH key you created before. The whole key (all of its belonging lines) under `backup_borg_ssh_key_private` needs to be indented with 2 spaces To backup without encryption, add `backup_borg_encryption: 'none'` to your vars. This will also enable the `backup_borg_unknown_unencrypted_repo_access_is_ok` variable. diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index b8f611107b2..b2d05308dfe 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -38,12 +38,12 @@ matrix_bot_baibot_enabled: true # Uncomment and adjust this part if you'd like to use a username different than the default # matrix_bot_baibot_config_user_mxid_localpart: baibot -# Generate a strong password here. Consider generating it with `pwgen -s 64 1`. +# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. # If you'd like to change this password subsequently, see the details below. matrix_bot_baibot_config_user_password: 'PASSWORD_FOR_THE_BOT' # An optional passphrase to use for backing up and recovering the bot's encryption keys. -# You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`). +# You can create one with a command like `pwgen -s 64 1`. # # If set to null, the recovery module will not be used and losing your session/database # will mean you lose access to old messages in encrypted room. diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index 7a1a33be894..3fa6b4a436a 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -14,7 +14,7 @@ matrix_bot_buscarron_enabled: true # Uncomment and adjust this part if you'd like to use a username different than the default # matrix_bot_buscarron_login: bot.buscarron -# Generate a strong password here. Consider generating it with `pwgen -s 64 1` +# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. matrix_bot_buscarron_password: PASSWORD_FOR_THE_BOT # Adjust accepted forms diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index 00c40b674a0..659ae77bbb8 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -12,7 +12,7 @@ The playbook does not automatically create users for you. The bot requires an ac You **need to register the bot user manually** before setting up the bot. -Choose a strong password for the bot. You can generate a good password with a command like this: `pwgen -s 64 1`. +Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. You can use the playbook to [register a new user](registering-users.md): diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index c4a0239c80c..f4ce3e75995 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -14,7 +14,7 @@ If your migrating from Mjolnir skip to [this section](#migrating-from-mjolnir-on The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot. -Choose a strong password for the bot. You can generate a good password with a command like this: `pwgen -s 64 1`. +Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. You can use the playbook to [register a new user](registering-users.md): diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index f4e3222e98d..359f55d7394 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -14,7 +14,7 @@ The playbook does not automatically create users for you. The bot requires at le You **need to register the bot user manually** before setting up the bot. -Choose a strong password for the bot. You can generate a good password with a command like this: `pwgen -s 64 1`. +Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. You can use the playbook to [register a new user](registering-users.md): diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index 2f5379d1889..d0e887563c6 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -16,7 +16,7 @@ matrix_bot_honoroit_enabled: true # Uncomment and adjust this part if you'd like to use a username different than the default # matrix_bot_honoroit_login: honoroit -# Generate a strong password here. Consider generating it with `pwgen -s 64 1` +# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. matrix_bot_honoroit_password: PASSWORD_FOR_THE_BOT # Adjust this to your room ID diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index 84c2e244ecd..8eb1132e455 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -17,7 +17,7 @@ matrix_bot_matrix_registration_bot_enabled: true # Uncomment and adjust this part if you'd like to use a username different than the default # matrix_bot_matrix_registration_bot_matrix_user_id_localpart: bot.matrix-registration-bot -# Generate a strong password here. Consider generating it with `pwgen -s 64 1` +# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. matrix_bot_matrix_registration_bot_bot_password: PASSWORD_FOR_THE_BOT # Enables registration diff --git a/docs/configuring-playbook-bot-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index 476dc4aa9e3..d2b53fc6352 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -16,7 +16,7 @@ matrix_bot_matrix_reminder_bot_enabled: true # Uncomment and adjust this part if you'd like to use a username different than the default # matrix_bot_matrix_reminder_bot_matrix_user_id_localpart: bot.matrix-reminder-bot -# Generate a strong password here. Consider generating it with `pwgen -s 64 1` +# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. matrix_bot_matrix_reminder_bot_matrix_user_password: PASSWORD_FOR_THE_BOT # Adjust this to your timezone diff --git a/docs/configuring-playbook-bot-maubot.md b/docs/configuring-playbook-bot-maubot.md index b1ffb08da73..400898d395b 100644 --- a/docs/configuring-playbook-bot-maubot.md +++ b/docs/configuring-playbook-bot-maubot.md @@ -16,7 +16,7 @@ matrix_bot_maubot_enabled: true # Uncomment and adjust this part if you'd like to use a username different than the default # matrix_bot_maubot_login: bot.maubot -# Generate a strong password here. Consider generating it with `pwgen -s 64 1` +# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. matrix_bot_maubot_initial_password: PASSWORD_FOR_THE_BOT matrix_bot_maubot_admins: diff --git a/docs/configuring-playbook-bot-mjolnir.md b/docs/configuring-playbook-bot-mjolnir.md index 0a52f63fa88..59630ae013b 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -10,7 +10,7 @@ See the project's [documentation](https://github.com/matrix-org/mjolnir/blob/mai The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot. -Choose a strong password for the bot. You can generate a good password with a command like this: `pwgen -s 64 1`. +Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. You can use the playbook to [register a new user](registering-users.md): diff --git a/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index 5aed1a144e7..15a7a39ec8f 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -29,7 +29,7 @@ matrix_postmoogle_enabled: true # Uncomment and adjust this part if you'd like to use a username different than the default # matrix_postmoogle_login: postmoogle -# Generate a strong password here. Consider generating it with `pwgen -s 64 1` +# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`. matrix_postmoogle_password: PASSWORD_FOR_THE_BOT # Uncomment to add one or more admins to this bridge: diff --git a/docs/configuring-playbook-matrix-registration.md b/docs/configuring-playbook-matrix-registration.md index 73168fdb807..4a1eeeaf5ec 100644 --- a/docs/configuring-playbook-matrix-registration.md +++ b/docs/configuring-playbook-matrix-registration.md @@ -23,7 +23,7 @@ To enable matrix-registration, add the following configuration to your `inventor ```yaml matrix_registration_enabled: true -# Generate a strong secret here. Consider generating it with `pwgen -s 64 1` +# Generate a strong secret here. You can create one with a command like `pwgen -s 64 1`. matrix_registration_admin_secret: "ENTER_SOME_SECRET_HERE" ``` diff --git a/docs/configuring-playbook-shared-secret-auth.md b/docs/configuring-playbook-shared-secret-auth.md index 633438aa9a6..c7dced046b6 100644 --- a/docs/configuring-playbook-shared-secret-auth.md +++ b/docs/configuring-playbook-shared-secret-auth.md @@ -11,7 +11,7 @@ Add the following configuration to your `inventory/host_vars/matrix.example.com/ ```yaml matrix_synapse_ext_password_provider_shared_secret_auth_enabled: true -# Generate a strong shared secret here. Consider generating it with `pwgen -s 64 1` +# Generate a strong shared secret here. You can create one with a command like `pwgen -s 64 1`. matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret: YOUR_SHARED_SECRET_GOES_HERE ``` diff --git a/examples/vars.yml b/examples/vars.yml index 31a42167138..36b1fb15324 100644 --- a/examples/vars.yml +++ b/examples/vars.yml @@ -20,7 +20,7 @@ matrix_domain: example.com matrix_homeserver_implementation: synapse # A secret used as a base, for generating various other secrets. -# You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`). +# You can put any string here, but generating a strong one is preferred. You can create one with a command like `pwgen -s 64 1`. matrix_homeserver_generic_secret_key: '' # By default, the playbook manages its own Traefik (https://doc.traefik.io/traefik/) reverse-proxy server.