diff --git a/CHANGELOG.md b/CHANGELOG.md index 47e9d92bb..24663068f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1354,7 +1354,7 @@ Our [justfile](justfile) already defines some additional helpful **shortcut** co - `just run-tags install-mautrix-slack,start` - to run specific playbook tags - `just start-all` - (re-)starts all services - `just stop-group postgres` - to stop only the Postgres service -- `just register-user john secret-password yes` - registers a `john` user with the `secret-password` password and admin access (admin = `yes`) +- `just register-user alice secret-password yes` - registers an `alice` user with the `secret-password` password and admin access (admin = `yes`) Additional helpful commands and shortcuts may be defined in the future. diff --git a/docs/installing.md b/docs/installing.md index 391fe8590..a839c07b7 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -83,13 +83,13 @@ To create your user account (as an administrator of the server) via this Ansible **Notes**: - Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` -- For `YOUR_USERNAME_HERE`, use a plain username like `john`, not your full identifier (`@user:example.com`) +- For `YOUR_USERNAME_HERE`, use a plain username like `alice`, not your full identifier (`@alice:example.com`) - Use `admin=yes` to make your user account an administrator of the Matrix server ```sh ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE admin=yes' --tags=register-user -# Example: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=john password=secret-password admin=yes' --tags=register-user +# Example: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=alice password=secret-password admin=yes' --tags=register-user ``` Feel free to create as many accounts (for friends, family, etc.) as you want. Still, perhaps you should grant full administrative access to your account only (with `admin=yes`), and others should be created with `admin=no`. diff --git a/docs/just.md b/docs/just.md index d47ae00f3..ecc09e495 100644 --- a/docs/just.md +++ b/docs/just.md @@ -10,18 +10,18 @@ For some recipes such as `just update`, our `justfile` recommends installing [`a Here are some examples of shortcuts: -| Shortcut | Result | -|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------| -| `just roles` | Install the necessary Ansible roles pinned in [`requirements.yml`](../requirements.yml) | -| `just update` | Run `git pull` (to update the playbook) and install the Ansible roles | -| `just install-all` | Run `ansible-playbook -i inventory/hosts setup.yml --tags=install-all,ensure-matrix-users-created,start` | -| `just setup-all` | Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start` | -| `just install-all --ask-vault-pass` | Run commands with additional arguments (`--ask-vault-pass` will be appended to the above installation command) | -| `just run-tags install-mautrix-slack,start` | Run specific playbook tags (here `install-mautrix-slack` and `start`) | -| `just install-service mautrix-slack` | Run `just run-tags install-mautrix-slack,start` with even less typing | -| `just start-all` | (Re-)starts all services | -| `just stop-group postgres` | Stop only the Postgres service | -| `just register-user john secret-password yes` | Registers a `john` user with the `secret-password` password and admin access (admin = `yes`) | +| Shortcut | Result | +|------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| `just roles` | Install the necessary Ansible roles pinned in [`requirements.yml`](../requirements.yml) | +| `just update` | Run `git pull` (to update the playbook) and install the Ansible roles | +| `just install-all` | Run `ansible-playbook -i inventory/hosts setup.yml --tags=install-all,ensure-matrix-users-created,start` | +| `just setup-all` | Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start` | +| `just install-all --ask-vault-pass` | Run commands with additional arguments (`--ask-vault-pass` will be appended to the above installation command) | +| `just run-tags install-mautrix-slack,start` | Run specific playbook tags (here `install-mautrix-slack` and `start`) | +| `just install-service mautrix-slack` | Run `just run-tags install-mautrix-slack,start` with even less typing | +| `just start-all` | (Re-)starts all services | +| `just stop-group postgres` | Stop only the Postgres service | +| `just register-user alice secret-password yes` | Registers an `alice` user with the `secret-password` password and admin access (admin = `yes`) | While [our documentation on prerequisites](prerequisites.md) lists `just` as one of the requirements for installation, using `just` is optional. If you find it difficult to install it, do not find it useful, or want to prefer raw `ansible-playbook` commands for some reason, feel free to run all commands manually. For example, you can run `ansible-galaxy` directly to install the Ansible roles: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force`. diff --git a/docs/quick-start.md b/docs/quick-start.md index 6100c82dc..b08af6514 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -136,12 +136,12 @@ To create your user account (as an administrator of the server) via this Ansible **💡 Notes**: - Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` -- For `YOUR_USERNAME_HERE`, use a plain username like `john`, not your full identifier (`@user:example.com`) +- For `YOUR_USERNAME_HERE`, use a plain username like `alice`, not your full identifier (`@alice:example.com`) ```sh ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE admin=yes' --tags=register-user -# Example: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=john password=secret-password admin=yes' --tags=register-user +# Example: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=alice password=secret-password admin=yes' --tags=register-user ```