Skip to content

Commit

Permalink
Edit docs: consistent instructions to generate passphrases or secrets…
Browse files Browse the repository at this point in the history
… with pwgen

This commit replaces instructions to create passwords, passphrases, or secrets with common ones.

Signed-off-by: Suguru Hirahara <[email protected]>
  • Loading branch information
Suguru Hirahara committed Dec 22, 2024
1 parent f204a3a commit 6b87d1a
Show file tree
Hide file tree
Showing 17 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-alertmanager-receiver.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-backup-borg.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/configuring-playbook-bot-baibot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-buscarron.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-chatgpt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-draupnir.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-go-neb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-honoroit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-matrix-registration-bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-matrix-reminder-bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-maubot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bot-mjolnir.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-bridge-postmoogle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-matrix-registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
Expand Down
2 changes: 1 addition & 1 deletion docs/configuring-playbook-shared-secret-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion examples/vars.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 6b87d1a

Please sign in to comment.