nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 13:17:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
hookshot/config.sample.yml

193 lines
4.9 KiB
YAML
Raw Normal View History

Generate default config automatically
2020-12-13 14:55:36 +00:00
# This is an example configuration file
Add sample config
2021-04-11 16:07:43 +01:00
bridge:
# Basic homeserver configuration
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add sample config
2021-04-11 16:07:43 +01:00
domain: example.com
url: http://localhost:8008
Change URL protocol in the ocumentation and sample configs to HTTPS (#623) * Config: Use variables for similar values * Configs and Documentation: http -> https, except for localhost
2023-01-13 16:39:34 +01:00
mediaUrl: https://example.com
Add sample config
2021-04-11 16:07:43 +01:00
port: 9993
bindAddress: 127.0.0.1
github:
Update default config
2021-11-17 12:29:34 +00:00
# (Optional) Configure this to enable GitHub support
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add sample config
2021-04-11 16:07:43 +01:00
auth:
Update sample config
2021-12-01 10:54:47 +00:00
# Authentication for the GitHub App.
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add sample config
2021-04-11 16:07:43 +01:00
id: 123
privateKeyFile: github-key.pem
Update sample config
2021-12-01 10:54:47 +00:00
webhook:
# Webhook settings for the GitHub app.
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Update sample config
2021-12-01 10:54:47 +00:00
secret: secrettoken
Add sample config
2021-04-11 16:07:43 +01:00
oauth:
Update sample config
2021-12-01 10:54:47 +00:00
# (Optional) Settings for allowing users to sign in via OAuth.
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add sample config
2021-04-11 16:07:43 +01:00
client_id: foo
client_secret: bar
redirect_uri: https://example.com/bridge_oauth/
Update sample config
2021-12-01 10:54:47 +00:00
defaultOptions:
# (Optional) Default options for GitHub connections.
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Update sample config
2021-12-01 10:54:47 +00:00
showIssueRoomLink: false
Support hotlinking github issues and PRs (#277) * Support hotlinking github issues and PRs * changelog * update sample config * Update github_repo.md
2022-04-06 18:46:04 +01:00
hotlinkIssues:
prefix: "#"
Fix GitHub and GitLab ghost user intent creation (#303) * Fix GitHub and GitLab ghost user intent creation, and add config * changelog
2022-04-12 18:46:14 +01:00
userIdPrefix:
# (Optional) Prefix used when creating ghost users for GitHub accounts.
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Fix GitHub and GitLab ghost user intent creation (#303) * Fix GitHub and GitLab ghost user intent creation, and add config * changelog
2022-04-12 18:46:14 +01:00
_github_
Add sample config
2021-04-11 16:07:43 +01:00
gitlab:
Update default config
2021-11-17 12:29:34 +00:00
# (Optional) Configure this to enable GitLab support
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add sample config
2021-04-11 16:07:43 +01:00
instances:
gitlab.com:
url: https://gitlab.com
webhook:
secret: secrettoken
Add setup command for GitLab (#321) * Cleanup gitlab auth command * Add support for the `!hookshot gitlab project` command * Improve docs * changelog * add new page * Wording Co-authored-by: Tadeusz Sośnierz <tadzik@tadzik.net> * Remove useless comment Co-authored-by: Tadeusz Sośnierz <tadzik@tadzik.net>
2022-04-26 16:04:24 +01:00
publicUrl: https://example.com/hookshot/
Fix GitHub and GitLab ghost user intent creation (#303) * Fix GitHub and GitLab ghost user intent creation, and add config * changelog
2022-04-12 18:46:14 +01:00
userIdPrefix:
# (Optional) Prefix used when creating ghost users for GitLab accounts.
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Fix GitHub and GitLab ghost user intent creation (#303) * Fix GitHub and GitLab ghost user intent creation, and add config * changelog
2022-04-12 18:46:14 +01:00
_gitlab_
Add Generic Webhooks Widget interface (#140) * Start work on improved widget interface for admin room * Add changes needed for InviteView * More widget bits * Lots more work to support setup widgets * Redesign work * Fix build order for web * Remove unused invite code * Update configs * Cleanup * Support widget branding * Tidy up web app * Support generic service config lookup * Stronger typings for configuration * Improve error text * fix patch * changelog * First pass on documentation * Fix tests * fixes * Don't require room state / admin rooms for room config requests * Fix no render when secrets isn't provided * rework if logic * Fixes after feedback * more review fixes * Cleanup unused code * fix indent * Update matrix-appservice-bridge to 4.0.1 * Update widget API
2022-04-08 16:16:12 +01:00
figma:
# (Optional) Configure this to enable Figma support
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add Generic Webhooks Widget interface (#140) * Start work on improved widget interface for admin room * Add changes needed for InviteView * More widget bits * Lots more work to support setup widgets * Redesign work * Fix build order for web * Remove unused invite code * Update configs * Cleanup * Support widget branding * Tidy up web app * Support generic service config lookup * Stronger typings for configuration * Improve error text * fix patch * changelog * First pass on documentation * Fix tests * fixes * Don't require room state / admin rooms for room config requests * Fix no render when secrets isn't provided * rework if logic * Fixes after feedback * more review fixes * Cleanup unused code * fix indent * Update matrix-appservice-bridge to 4.0.1 * Update widget API
2022-04-08 16:16:12 +01:00
publicUrl: https://example.com/hookshot/
instances:
your-instance:
teamId: your-team-id
accessToken: your-personal-access-token
passcode: your-webhook-passcode
Update default config
2021-11-17 12:29:34 +00:00
jira:
Refactor JIRA to support on-prem (#187) * JIRA refactors * Support JIRA onprem * Fix webhooks * More JIRA docs --- PLEASE REWRITE MEEEE --- * Drop manifest code for now * Add on-prem instructions * Remove incomplete command * Update sample config * Remove null url
2022-03-04 14:34:44 +00:00
# (Optional) Configure this to enable Jira support. Only specify `url` if you are using a On Premise install (i.e. not atlassian.com)
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Fix config
2021-11-17 12:31:01 +00:00
webhook:
Refactor JIRA to support on-prem (#187) * JIRA refactors * Support JIRA onprem * Fix webhooks * More JIRA docs --- PLEASE REWRITE MEEEE --- * Drop manifest code for now * Add on-prem instructions * Remove incomplete command * Update sample config * Remove null url
2022-03-04 14:34:44 +00:00
# Webhook settings for JIRA
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Fix config
2021-11-17 12:31:01 +00:00
secret: secrettoken
Make CI happy
2021-11-25 11:12:29 +00:00
oauth:
Refactor JIRA to support on-prem (#187) * JIRA refactors * Support JIRA onprem * Fix webhooks * More JIRA docs --- PLEASE REWRITE MEEEE --- * Drop manifest code for now * Add on-prem instructions * Remove incomplete command * Update sample config * Remove null url
2022-03-04 14:34:44 +00:00
# (Optional) OAuth settings for connecting users to JIRA. See documentation for more information
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Make CI happy
2021-11-25 11:12:29 +00:00
client_id: foo
client_secret: bar
redirect_uri: https://example.com/bridge_oauth/
Fix config
2021-11-17 12:31:01 +00:00
generic:
Move webhooks from / to /webhook (#227) * Move webhooks from / to /webhooks * fix doc * Update docs * Fix tests * changelog * Update sample config * fixup config * fix changelog * commit config changes
2022-03-07 23:57:06 +00:00
# (Optional) Support for generic webhook events.
#'allowJsTransformationFunctions' will allow users to write short transformation snippets in code, and thus is unsafe in untrusted environments
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Fix config
2021-11-17 12:31:01 +00:00
enabled: false
Disable GET for webhooks (unless configured) (#397) * Disable GET for webhooks (unless configured) * Docs * newsfile * Update Config.ts
2022-07-07 22:52:59 +01:00
enableHttpGet: false
Move webhooks from / to /webhook (#227) * Move webhooks from / to /webhooks * fix doc * Update docs * Fix tests * changelog * Update sample config * fixup config * fix changelog * commit config changes
2022-03-07 23:57:06 +00:00
urlPrefix: https://example.com/webhook/
Add Generic Webhooks Widget interface (#140) * Start work on improved widget interface for admin room * Add changes needed for InviteView * More widget bits * Lots more work to support setup widgets * Redesign work * Fix build order for web * Remove unused invite code * Update configs * Cleanup * Support widget branding * Tidy up web app * Support generic service config lookup * Stronger typings for configuration * Improve error text * fix patch * changelog * First pass on documentation * Fix tests * fixes * Don't require room state / admin rooms for room config requests * Fix no render when secrets isn't provided * rework if logic * Fixes after feedback * more review fixes * Cleanup unused code * fix indent * Update matrix-appservice-bridge to 4.0.1 * Update widget API
2022-04-08 16:16:12 +01:00
userIdPrefix: _webhooks_
Fix config
2021-11-17 12:31:01 +00:00
allowJsTransformationFunctions: false
Move webhooks from / to /webhook (#227) * Move webhooks from / to /webhooks * fix doc * Update docs * Fix tests * changelog * Update sample config * fixup config * fix changelog * commit config changes
2022-03-07 23:57:06 +00:00
waitForComplete: false
Add RSS/Atom feed support
2022-04-20 18:13:06 +02:00
feeds:
Update config defaults
2022-04-22 11:25:05 +02:00
# (Optional) Configure this to enable RSS/Atom feed support
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add RSS/Atom feed support
2022-04-20 18:13:06 +02:00
enabled: false
pollIntervalSeconds: 600
Increase feed.pollTimeoutSeconds from 10s to 30s (#483) * Increase feed.pollTimeoutSeconds from 10s to 30s * Drop pointless default * changelog
2022-11-25 14:46:06 +00:00
pollTimeoutSeconds: 30
Update sample config
2021-11-25 13:30:19 +00:00
provisioning:
# (Optional) Provisioning API for integration managers
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Update sample config
2021-11-25 13:30:19 +00:00
secret: "!secretToken"
Add sample config
2021-04-11 16:07:43 +01:00
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
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add sample config
2021-04-11 16:07:43 +01:00
passkey.pem
Add towncrier (#96) * Add support for towncrier * Use correct command * Compare properly * Work within the correct directory * Try main * Try a fetch-depth of 0 * changelog * Fix default config * Update sample
2021-12-13 13:10:36 +00:00
bot:
# (Optional) Define profile information for the bot user
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Implement separate bot users per service (#573) * Add service bots config * Add joined rooms manager and keep track of joined rooms * Add bot users manager and ensure registration and profiles * Improve joined rooms manager and set up already joined rooms * Handle invites with service bots * Handle messages with service bots * Use service bots for connections * Use service bots in widget and provisioning APIs * Use service bots in setup connections * Use service bots for feed connections * Handle admin rooms for service bots * Fix confused event type and service type in provisioning and widget APIs * Fix generic webhooks service name * Fix enabled services config * Handle power level change * Create widgets with service scope * Use service bots for gitlab repo connections * Use service bots for gitlab issue connections * Use service bots for generic webhook connections * Use service bots for figma file connections * Use service bots when verifying state events * Use service bots for github repo connections * Use service bots for github discussion connections * Use service bots for github discussion space connections * Use service bots for github project connections * Use service bots for github issue connections * Use service bots for github user space connections * Use service bots for jira connections * Make sure ghost users are invited for gitlab issue comments * Configure one service per service bot * Add changelog * Update tests * Fix up following rebase * Fix comment * Use getter for enabled services * Ensure homeserver can be reached before registering bots * Add intent getter on bot user * Update config comment * Merge joined rooms manager with bot users manager * Remove unused localpart from bot user class * Refactor to pass in bot users manager * Improve priority sort function Co-authored-by: Christian Paul <christianp@matrix.org> * Fix priority sort Higher priority should come first * Add debug log when invites are rejected * Use different state key for scoped setup widgets * Use different subtitles to differentiate service bots setup widgets * Refactor bot user setup into bot users manager * Refactor to reduce duplication in widget API * Consistent room ID and intent args order * Add docs and update changelog * Add overrideUserId deprecation warning * Add service bots link Co-authored-by: Christian Paul <christianp@matrix.org> Co-authored-by: Will Hunt <will@half-shot.uk>
2023-01-13 10:32:09 -05:00
displayname: Hookshot Bot
Add towncrier (#96) * Add support for towncrier * Use correct command * Compare properly * Work within the correct directory * Try main * Try a fetch-depth of 0 * changelog * Fix default config * Update sample
2021-12-13 13:10:36 +00:00
avatar: mxc://half-shot.uk/2876e89ccade4cb615e210c458e2a7a6883fe17d
Implement separate bot users per service (#573) * Add service bots config * Add joined rooms manager and keep track of joined rooms * Add bot users manager and ensure registration and profiles * Improve joined rooms manager and set up already joined rooms * Handle invites with service bots * Handle messages with service bots * Use service bots for connections * Use service bots in widget and provisioning APIs * Use service bots in setup connections * Use service bots for feed connections * Handle admin rooms for service bots * Fix confused event type and service type in provisioning and widget APIs * Fix generic webhooks service name * Fix enabled services config * Handle power level change * Create widgets with service scope * Use service bots for gitlab repo connections * Use service bots for gitlab issue connections * Use service bots for generic webhook connections * Use service bots for figma file connections * Use service bots when verifying state events * Use service bots for github repo connections * Use service bots for github discussion connections * Use service bots for github discussion space connections * Use service bots for github project connections * Use service bots for github issue connections * Use service bots for github user space connections * Use service bots for jira connections * Make sure ghost users are invited for gitlab issue comments * Configure one service per service bot * Add changelog * Update tests * Fix up following rebase * Fix comment * Use getter for enabled services * Ensure homeserver can be reached before registering bots * Add intent getter on bot user * Update config comment * Merge joined rooms manager with bot users manager * Remove unused localpart from bot user class * Refactor to pass in bot users manager * Improve priority sort function Co-authored-by: Christian Paul <christianp@matrix.org> * Fix priority sort Higher priority should come first * Add debug log when invites are rejected * Use different state key for scoped setup widgets * Use different subtitles to differentiate service bots setup widgets * Refactor bot user setup into bot users manager * Refactor to reduce duplication in widget API * Consistent room ID and intent args order * Add docs and update changelog * Add overrideUserId deprecation warning * Add service bots link Co-authored-by: Christian Paul <christianp@matrix.org> Co-authored-by: Will Hunt <will@half-shot.uk>
2023-01-13 10:32:09 -05:00
serviceBots:
# (Optional) Define additional bot users for specific services
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Implement separate bot users per service (#573) * Add service bots config * Add joined rooms manager and keep track of joined rooms * Add bot users manager and ensure registration and profiles * Improve joined rooms manager and set up already joined rooms * Handle invites with service bots * Handle messages with service bots * Use service bots for connections * Use service bots in widget and provisioning APIs * Use service bots in setup connections * Use service bots for feed connections * Handle admin rooms for service bots * Fix confused event type and service type in provisioning and widget APIs * Fix generic webhooks service name * Fix enabled services config * Handle power level change * Create widgets with service scope * Use service bots for gitlab repo connections * Use service bots for gitlab issue connections * Use service bots for generic webhook connections * Use service bots for figma file connections * Use service bots when verifying state events * Use service bots for github repo connections * Use service bots for github discussion connections * Use service bots for github discussion space connections * Use service bots for github project connections * Use service bots for github issue connections * Use service bots for github user space connections * Use service bots for jira connections * Make sure ghost users are invited for gitlab issue comments * Configure one service per service bot * Add changelog * Update tests * Fix up following rebase * Fix comment * Use getter for enabled services * Ensure homeserver can be reached before registering bots * Add intent getter on bot user * Update config comment * Merge joined rooms manager with bot users manager * Remove unused localpart from bot user class * Refactor to pass in bot users manager * Improve priority sort function Co-authored-by: Christian Paul <christianp@matrix.org> * Fix priority sort Higher priority should come first * Add debug log when invites are rejected * Use different state key for scoped setup widgets * Use different subtitles to differentiate service bots setup widgets * Refactor bot user setup into bot users manager * Refactor to reduce duplication in widget API * Consistent room ID and intent args order * Add docs and update changelog * Add overrideUserId deprecation warning * Add service bots link Co-authored-by: Christian Paul <christianp@matrix.org> Co-authored-by: Will Hunt <will@half-shot.uk>
2023-01-13 10:32:09 -05:00
- localpart: feeds
displayname: Feeds
Add support for uploading avatars (#767) * Add uploading configured avatar images * Add avatar assets * Update docs and sample config * Add changelog * Fix sample config * Add removing avatars when none configured
2023-05-24 09:16:37 -04:00
avatar: ./assets/feeds_avatar.png
Implement separate bot users per service (#573) * Add service bots config * Add joined rooms manager and keep track of joined rooms * Add bot users manager and ensure registration and profiles * Improve joined rooms manager and set up already joined rooms * Handle invites with service bots * Handle messages with service bots * Use service bots for connections * Use service bots in widget and provisioning APIs * Use service bots in setup connections * Use service bots for feed connections * Handle admin rooms for service bots * Fix confused event type and service type in provisioning and widget APIs * Fix generic webhooks service name * Fix enabled services config * Handle power level change * Create widgets with service scope * Use service bots for gitlab repo connections * Use service bots for gitlab issue connections * Use service bots for generic webhook connections * Use service bots for figma file connections * Use service bots when verifying state events * Use service bots for github repo connections * Use service bots for github discussion connections * Use service bots for github discussion space connections * Use service bots for github project connections * Use service bots for github issue connections * Use service bots for github user space connections * Use service bots for jira connections * Make sure ghost users are invited for gitlab issue comments * Configure one service per service bot * Add changelog * Update tests * Fix up following rebase * Fix comment * Use getter for enabled services * Ensure homeserver can be reached before registering bots * Add intent getter on bot user * Update config comment * Merge joined rooms manager with bot users manager * Remove unused localpart from bot user class * Refactor to pass in bot users manager * Improve priority sort function Co-authored-by: Christian Paul <christianp@matrix.org> * Fix priority sort Higher priority should come first * Add debug log when invites are rejected * Use different state key for scoped setup widgets * Use different subtitles to differentiate service bots setup widgets * Refactor bot user setup into bot users manager * Refactor to reduce duplication in widget API * Consistent room ID and intent args order * Add docs and update changelog * Add overrideUserId deprecation warning * Add service bots link Co-authored-by: Christian Paul <christianp@matrix.org> Co-authored-by: Will Hunt <will@half-shot.uk>
2023-01-13 10:32:09 -05:00
prefix: "!feeds"
service: feeds
Add support for prometheus (#99) * Add support for prometheus metrics * Automatically build metrics documentation * Slight linter tidyup * add changelog * fix workflow * hush yarn
2021-12-16 15:05:03 +00:00
metrics:
# (Optional) Prometheus metrics support
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add support for prometheus (#99) * Add support for prometheus metrics * Automatically build metrics documentation * Slight linter tidyup * add changelog * fix workflow * hush yarn
2021-12-16 15:05:03 +00:00
enabled: true
Add sample config
2021-04-11 16:07:43 +01:00
queue:
Add support for native e2ee (#299) * Add support for native e2ee * Various temps to coax it into working * Formatting nitpicks * Include stable registration config key for msc2409 * Update default config with encryption options * Manage admin rooms with bot-sdk DMs This also enables encryption for new admin rooms when appropriate. * Update config comments for encryption settings - Add comment to clarify Redis (the `queue` section) must be configured in order for encryption to work - Mention that the `encryption` section is optional, and omitting it will disable encryption support * Update docs for encryption support * Add changelog * Add to docs some notes about encryption state * Move all post-join logic to onRoomJoin * Block post-join actions on crypto setup Requires https://github.com/turt2live/matrix-bot-sdk/pull/269 * Fix linter error * Update encryption docs and changelog - Mention that worker mode isn't supported with encryption yet - Mention removal of Pantalaimon-based encryption * Update worker docs with encryption config notice * Share main appservice config with feed bots This is required to safely enable encryption for the bots that post GenericHook messages. * Make slight clarification for queue config * Minor fixes * Block post-join actions on feed bot crypto setup Same as a9e6e11d but for the sub-bots that post GenericHook messages. * Get joined rooms from intent instead of bot This refreshes the list of known rooms for crypto events. * Use Element fork of bot-sdk for crypto fixes Co-authored-by: Andrew Ferrazzutti <andrewf@element.io>
2022-12-09 15:25:36 +00:00
# (Optional) Message queue / cache configuration options for large scale deployments.
# For encryption to work, must be set to monolithic mode and have a host & port specified.
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add sample config
2021-04-11 16:07:43 +01:00
monolithic: true
port: 6379
host: localhost
logging:
# (Optional) Logging settings. You can have a severity debug,info,warn,error
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add sample config
2021-04-11 16:07:43 +01:00
level: info
Refactor logging to be much more flexible and less noisy (#229) * Add new logging config options * Reduce logging noise * Identify more sources of noise * Add new colourize and json options for logging * Update documentation * changelog
2022-03-07 20:04:26 +00:00
colorize: true
json: false
timestampFormat: HH:mm:ss:SSS
Add Generic Webhooks Widget interface (#140) * Start work on improved widget interface for admin room * Add changes needed for InviteView * More widget bits * Lots more work to support setup widgets * Redesign work * Fix build order for web * Remove unused invite code * Update configs * Cleanup * Support widget branding * Tidy up web app * Support generic service config lookup * Stronger typings for configuration * Improve error text * fix patch * changelog * First pass on documentation * Fix tests * fixes * Don't require room state / admin rooms for room config requests * Fix no render when secrets isn't provided * rework if logic * Fixes after feedback * more review fixes * Cleanup unused code * fix indent * Update matrix-appservice-bridge to 4.0.1 * Update widget API
2022-04-08 16:16:12 +01:00
widgets:
# (Optional) EXPERIMENTAL support for complimentary widgets
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add Generic Webhooks Widget interface (#140) * Start work on improved widget interface for admin room * Add changes needed for InviteView * More widget bits * Lots more work to support setup widgets * Redesign work * Fix build order for web * Remove unused invite code * Update configs * Cleanup * Support widget branding * Tidy up web app * Support generic service config lookup * Stronger typings for configuration * Improve error text * fix patch * changelog * First pass on documentation * Fix tests * fixes * Don't require room state / admin rooms for room config requests * Fix no render when secrets isn't provided * rework if logic * Fixes after feedback * more review fixes * Cleanup unused code * fix indent * Update matrix-appservice-bridge to 4.0.1 * Update widget API
2022-04-08 16:16:12 +01:00
addToAdminRooms: false
disallowedIpRanges:
- 127.0.0.0/8
- 10.0.0.0/8
- 172.16.0.0/12
- 192.168.0.0/16
- 100.64.0.0/10
- 192.0.0.0/24
- 169.254.0.0/16
- 192.88.99.0/24
- 198.18.0.0/15
- 192.0.2.0/24
- 198.51.100.0/24
- 203.0.113.0/24
- 224.0.0.0/4
- ::1/128
- fe80::/10
- fc00::/7
- 2001:db8::/32
- ff00::/8
- fec0::/10
roomSetupWidget:
addOnInvite: false
Change URL protocol in the ocumentation and sample configs to HTTPS (#623) * Config: Use variables for similar values * Configs and Documentation: http -> https, except for localhost
2023-01-13 16:39:34 +01:00
publicUrl: https://example.com/widgetapi/v1/static/
Add Generic Webhooks Widget interface (#140) * Start work on improved widget interface for admin room * Add changes needed for InviteView * More widget bits * Lots more work to support setup widgets * Redesign work * Fix build order for web * Remove unused invite code * Update configs * Cleanup * Support widget branding * Tidy up web app * Support generic service config lookup * Stronger typings for configuration * Improve error text * fix patch * changelog * First pass on documentation * Fix tests * fixes * Don't require room state / admin rooms for room config requests * Fix no render when secrets isn't provided * rework if logic * Fixes after feedback * more review fixes * Cleanup unused code * fix indent * Update matrix-appservice-bridge to 4.0.1 * Update widget API
2022-04-08 16:16:12 +01:00
branding:
widgetTitle: Hookshot Configuration
Add Sentry support (#754) * Add sentry support * Add basic listening for errors on express. * Additional event types * Add a default config * changelog * Improve wording * Add docs
2023-05-18 12:05:23 +01:00
sentry:
# (Optional) Configure Sentry error reporting
dsn: https://examplePublicKey@o0.ingest.sentry.io/0
environment: production
Add support for a tiered permission system (#167) * Add basic permission model * Add permission mapping implementation * Start integrating config checks * Add permission checking for commands * Add warnings for legacy behaviour * changelog * Linting * Fix config build step * Tests * Add documentation * Add complete tests * Add documentation * Add room for room membership permissions * Fixup error * Update sampleConfig
2022-01-14 17:44:15 +00:00
permissions:
# (Optional) Permissions for using the bridge. See docs/setup.md#permissions for help
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add support for a tiered permission system (#167) * Add basic permission model * Add permission mapping implementation * Start integrating config checks * Add permission checking for commands * Add warnings for legacy behaviour * changelog * Linting * Fix config build step * Tests * Add documentation * Add complete tests * Add documentation * Add room for room membership permissions * Fixup error * Update sampleConfig
2022-01-14 17:44:15 +00:00
- actor: example.com
services:
- service: "*"
level: admin
Add a listeners config block (#102) * Add support for a multi-resource listener style handler * Update configs * Speed up config check * Speed up config check * Update docs
2021-12-21 16:52:12 +00:00
listeners:
# (Optional) HTTP Listener configuration.
# Bind resource endpoints to ports and addresses.
Docs and config improvements (#124) * 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
2022-01-04 17:49:59 +00:00
# '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
Update yaml dependency (#728) * Update yaml dependency * changelog
2023-04-25 16:52:57 +01:00
Add a listeners config block (#102) * Add support for a multi-resource listener style handler * Update configs * Speed up config check * Speed up config check * Update docs
2021-12-21 16:52:12 +00:00
- port: 9000
bindAddress: 0.0.0.0
resources:
- webhooks
- port: 9001
bindAddress: 127.0.0.1
resources:
- metrics
- provisioning
Fail to start when widgets are configured without a listener (#298) * Add note about listener configuration in widgets.md * Add errors to check when widgets are not fully configured * changelog * Include widget listener in default config
2022-04-11 18:39:42 +01:00
- port: 9002
bindAddress: 0.0.0.0
resources:
- widgets
Add skeleton for admin room widget
2020-12-12 20:29:33 +00:00
Reference in New Issue Copy Permalink