mirror of
https://github.com/matrix-org/matrix-hookshot.git
synced 2025-03-10 13:17:08 +00:00
d860b9acd1
* Don't suggest to bind widgets in config * Don't support 'appservice' just yet for the listener service. * Add config validator * Clarify listener configuration * Improve text of webhooks docs * Update config sample * Revert "Add config validator" This reverts commit b422b3da3d246f9eb1a6b47641ea4c1315252c2c. * changelog
102 lines
2.7 KiB
YAML
102 lines
2.7 KiB
YAML
# This is an example configuration file
|
|
|
|
bridge:
|
|
# Basic homeserver configuration
|
|
#
|
|
domain: example.com
|
|
url: http://localhost:8008
|
|
mediaUrl: http://example.com
|
|
port: 9993
|
|
bindAddress: 127.0.0.1
|
|
github:
|
|
# (Optional) Configure this to enable GitHub support
|
|
#
|
|
auth:
|
|
# Authentication for the GitHub App.
|
|
#
|
|
id: 123
|
|
privateKeyFile: github-key.pem
|
|
webhook:
|
|
# Webhook settings for the GitHub app.
|
|
#
|
|
secret: secrettoken
|
|
oauth:
|
|
# (Optional) Settings for allowing users to sign in via OAuth.
|
|
#
|
|
client_id: foo
|
|
client_secret: bar
|
|
redirect_uri: https://example.com/bridge_oauth/
|
|
defaultOptions:
|
|
# (Optional) Default options for GitHub connections.
|
|
#
|
|
showIssueRoomLink: false
|
|
gitlab:
|
|
# (Optional) Configure this to enable GitLab support
|
|
#
|
|
instances:
|
|
gitlab.com:
|
|
url: https://gitlab.com
|
|
webhook:
|
|
secret: secrettoken
|
|
jira:
|
|
# (Optional) Configure this to enable Jira support
|
|
#
|
|
webhook:
|
|
secret: secrettoken
|
|
oauth:
|
|
client_id: foo
|
|
client_secret: bar
|
|
redirect_uri: https://example.com/bridge_oauth/
|
|
generic:
|
|
# (Optional) Support for generic webhook events. `allowJsTransformationFunctions` will allow users to write short transformation snippets in code, and thus is unsafe in untrusted environments
|
|
#
|
|
enabled: false
|
|
urlPrefix: https://example.com/mywebhookspath/
|
|
allowJsTransformationFunctions: false
|
|
userIdPrefix: webhooks_
|
|
provisioning:
|
|
# (Optional) Provisioning API for integration managers
|
|
#
|
|
secret: "!secretToken"
|
|
passFile:
|
|
# A passkey used to encrypt tokens stored inside the bridge.
|
|
# Run openssl genpkey -out passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:4096 to generate
|
|
#
|
|
passkey.pem
|
|
bot:
|
|
# (Optional) Define profile information for the bot user
|
|
#
|
|
displayname: GitHub Bot
|
|
avatar: mxc://half-shot.uk/2876e89ccade4cb615e210c458e2a7a6883fe17d
|
|
metrics:
|
|
# (Optional) Prometheus metrics support
|
|
#
|
|
enabled: true
|
|
queue:
|
|
# (Optional) Message queue / cache configuration options for large scale deployments
|
|
#
|
|
monolithic: true
|
|
port: 6379
|
|
host: localhost
|
|
logging:
|
|
# (Optional) Logging settings. You can have a severity debug,info,warn,error
|
|
#
|
|
level: info
|
|
listeners:
|
|
# (Optional) HTTP Listener configuration.
|
|
# Bind resource endpoints to ports and addresses.
|
|
# 'port' must be specified. Each listener must listen on a unique port.
|
|
# 'bindAddress' will default to '127.0.0.1' if not specified, which may not be suited to Docker environments.
|
|
# 'resources' may be any of webhooks, widgets, metrics, provisioning
|
|
#
|
|
- port: 9000
|
|
bindAddress: 0.0.0.0
|
|
resources:
|
|
- webhooks
|
|
- port: 9001
|
|
bindAddress: 127.0.0.1
|
|
resources:
|
|
- metrics
|
|
- provisioning
|
|
|