matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-hookshot.md
2022-01-06 18:55:36 +01:00

1.5 KiB

Setting up Hookshot (optional)

The playbook can install and configure matrix-hookshot for you.

See the project's documentation to learn what it does and why it might be useful to you.

Setup Instructions

Refer to the official instructions to learn what the individual options do.

  1. For each of the services (GitHub, GitLab, JIRA, generic webhooks) fill in the respected variables matrix_hookshot_service_* listed in main.yml as required.
  2. Take special note of the matrix_hookshot_*_enabled variables. Services that need no further configuration are enabled by default (GitLab, Generic), while you must first add the required configuration and enable the others (GitHub, Jira, Figma).
  3. If you've already installed Matrix services using the playbook before, you'll need to re-run it (--tags=setup-all,start). If not, proceed with configuring other playbook services and then with Installing. Get back to this guide once ready. Hookshot can be set up individually using the tag setup-hookshot.
  4. Refer to the official instructions to start using the bridge.

Other configuration options are available via the matrix_hookshot_configuration_extension_yaml variable.