Skip to content

Configuring Hookshot

See how to download example files from the helm chart here.

Configuration

Hookshot is disabled by default and needs to be explicitly enabled.

hookshot:
  enabled: true

Note that by default, Hookshot will be setup behind Synapse hostname unless configured with a dedicated ingress:

hookshot:
  ingress:
    host: <hookshot domain name>

Credentials

Credentials are generated if initSecrets is enabled. Alternatively they can either be provided inline in the values with value or if you have an existing Secret in the cluster in the same namespace you can use secret and secretKey to reference it.

If you don't want the chart to generate the secret, please refer to the following values fragments examples to see the secrets to configure.

Hookshot requires a RSA passkey and the registration file in appserviceRegistration.

  • charts/matrix-stack/ci/fragments/hookshot-secrets-in-helm.yaml
  • charts/matrix-stack/ci/fragments/hookshot-secrets-externally.yaml

Additional configuration

Additional Hookshot configuration is written in YAML. can be provided inline in the values as a string with

hookshot:
  additional:
    ## Either reference config to inject by:
    1-custom-config:
      config: |
        generic:
          enabled: true
          allowJsTransformationFunctions: false
          waitForComplete: true
          enableHttpGet: false
    ## Either reference an existing `Secret` by:
    2-custom-config:
      configSecret: custom-hookshot-config
      configSecretKey: shared.yaml