mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-27 03:18:31 +01:00
9a56aff933
- Add "To use the bot" if it does not exist: adopt the format of the docs for bridges - Add "Prerequisites" section if an API key or user account is required - Use the common instruction for getting an access token - Replace "Get" with "Obtain" about getting keys or access tokens - Replace placeholders for access tokens on docs/configuring-playbook-bot-go.neb.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
76 lines
3.8 KiB
Markdown
76 lines
3.8 KiB
Markdown
# Setting up Honoroit (optional)
|
|
|
|
The playbook can install and configure [Honoroit](https://github.com/etkecc/honoroit) for you.
|
|
|
|
It's a bot you can use to setup **your own helpdesk on matrix**
|
|
|
|
See the project's [documentation](https://github.com/etkecc/honoroit/blob/main/README.md) to learn what it does and why it might be useful to you.
|
|
|
|
## Adjusting the playbook configuration
|
|
|
|
To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
|
|
|
```yaml
|
|
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 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
|
|
matrix_bot_honoroit_roomid: "!qporfwt:{{ matrix_domain }}"
|
|
```
|
|
|
|
### Adjusting the Honoroit URL
|
|
|
|
By default, this playbook installs Honoroit on the `matrix.` subdomain, at the `/honoroit` path (https://matrix.example.com/honoroit). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section.
|
|
|
|
By tweaking the `matrix_bot_honoroit_hostname` and `matrix_bot_honoroit_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one.
|
|
|
|
Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
|
|
|
```yaml
|
|
# Change the default hostname and path prefix
|
|
matrix_bot_honoroit_hostname: honoroit.example.com
|
|
matrix_bot_honoroit_path_prefix: /
|
|
```
|
|
|
|
## Adjusting DNS records
|
|
|
|
If you've changed the default hostname, **you may need to adjust your DNS** records to point the Honoroit domain to the Matrix server.
|
|
|
|
See [Configuring DNS](configuring-dns.md) for details about DNS changes.
|
|
|
|
If you've decided to use the default hostname, you won't need to do any extra DNS configuration.
|
|
|
|
## Installing
|
|
|
|
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:
|
|
|
|
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
|
```sh
|
|
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
|
|
```
|
|
|
|
**Notes**:
|
|
|
|
- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.
|
|
|
|
- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
|
|
|
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed.
|
|
|
|
- If you change the bot password (`matrix_bot_honoroit_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_honoroit_password` to let the bot know its new password.
|
|
|
|
## Usage
|
|
|
|
To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @honoroit:example.com` where `example.com` is your base domain, not the `matrix.` domain).
|
|
|
|
After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room.
|
|
|
|
Send `!ho help` to the bot in the room to see the available commands.
|
|
|
|
You can also refer to the upstream [documentation](https://github.com/etkecc/honoroit#features).
|