mirror of
https://github.com/matrix-org/matrix-hookshot.git
synced 2025-03-10 21:19:13 +00:00
408 lines
19 KiB
HTML
408 lines
19 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="sidebar-visible no-js light">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>📃 Sample Configuration - Matrix Hookshot</title>
|
||
|
||
|
||
<!-- Custom HTML head -->
|
||
|
||
|
||
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
<meta name="description" content="">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="theme-color" content="#ffffff" />
|
||
|
||
<link rel="icon" href="../favicon.svg">
|
||
<link rel="shortcut icon" href="../favicon.png">
|
||
<link rel="stylesheet" href="../css/variables.css">
|
||
<link rel="stylesheet" href="../css/general.css">
|
||
<link rel="stylesheet" href="../css/chrome.css">
|
||
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
||
<!-- Fonts -->
|
||
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
||
<!-- Highlight.js Stylesheets -->
|
||
<link rel="stylesheet" href="../highlight.css">
|
||
<link rel="stylesheet" href="../tomorrow-night.css">
|
||
<link rel="stylesheet" href="../ayu-highlight.css">
|
||
|
||
<!-- Custom theme stylesheets -->
|
||
<link rel="stylesheet" href="../docs/_site/style.css">
|
||
|
||
</head>
|
||
<body>
|
||
<!-- Provide site root to javascript -->
|
||
<script type="text/javascript">
|
||
var path_to_root = "../";
|
||
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
</script>
|
||
|
||
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
<script type="text/javascript">
|
||
try {
|
||
var theme = localStorage.getItem('mdbook-theme');
|
||
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
||
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
}
|
||
|
||
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
}
|
||
} catch (e) { }
|
||
</script>
|
||
|
||
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
<script type="text/javascript">
|
||
var theme;
|
||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
var html = document.querySelector('html');
|
||
html.classList.remove('no-js')
|
||
html.classList.remove('light')
|
||
html.classList.add(theme);
|
||
html.classList.add('js');
|
||
</script>
|
||
|
||
<!-- Hide / unhide sidebar before it is displayed -->
|
||
<script type="text/javascript">
|
||
var html = document.querySelector('html');
|
||
var sidebar = 'hidden';
|
||
if (document.body.clientWidth >= 1080) {
|
||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
sidebar = sidebar || 'visible';
|
||
}
|
||
html.classList.remove('sidebar-visible');
|
||
html.classList.add("sidebar-" + sidebar);
|
||
</script>
|
||
|
||
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
<div class="sidebar-scrollbox">
|
||
<ol class="chapter"><li class="chapter-item expanded "><a href="../hookshot.html"><strong aria-hidden="true">1.</strong> ℹ️ Hookshot</a></li><li class="chapter-item expanded "><a href="../setup.html"><strong aria-hidden="true">2.</strong> ⚙️ Setup</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../setup/sample-configuration.html" class="active"><strong aria-hidden="true">2.1.</strong> 📃 Sample Configuration</a></li><li class="chapter-item expanded "><a href="../setup/feeds.html"><strong aria-hidden="true">2.2.</strong> Feeds</a></li><li class="chapter-item expanded "><a href="../setup/figma.html"><strong aria-hidden="true">2.3.</strong> Figma</a></li><li class="chapter-item expanded "><a href="../setup/github.html"><strong aria-hidden="true">2.4.</strong> GitHub</a></li><li class="chapter-item expanded "><a href="../setup/gitlab.html"><strong aria-hidden="true">2.5.</strong> GitLab</a></li><li class="chapter-item expanded "><a href="../setup/jira.html"><strong aria-hidden="true">2.6.</strong> JIRA</a></li><li class="chapter-item expanded "><a href="../setup/webhooks.html"><strong aria-hidden="true">2.7.</strong> Webhooks</a></li></ol></li><li class="chapter-item expanded "><a href="../usage.html"><strong aria-hidden="true">3.</strong> 👤 Usage</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/dynamic_rooms.html"><strong aria-hidden="true">3.1.</strong> Dynamic Rooms</a></li><li class="chapter-item expanded "><a href="../usage/auth.html"><strong aria-hidden="true">3.2.</strong> Authenticating</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration.html"><strong aria-hidden="true">3.3.</strong> Room Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/room_configuration/github_repo.html"><strong aria-hidden="true">3.3.1.</strong> GitHub Repo</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration/gitlab_project.html"><strong aria-hidden="true">3.3.2.</strong> GitLab Project</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration/jira_project.html"><strong aria-hidden="true">3.3.3.</strong> JIRA Project</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="../metrics.html"><strong aria-hidden="true">4.</strong> 📊 Metrics</a></li><li class="chapter-item expanded "><a href="../sentry.html"><strong aria-hidden="true">5.</strong> Sentry</a></li><li class="chapter-item expanded affix "><li class="part-title">🧑💻 Development</li><li class="chapter-item expanded "><a href="../contributing.html"><strong aria-hidden="true">6.</strong> Contributing</a></li><li class="chapter-item expanded affix "><li class="part-title">🥼 Advanced</li><li class="chapter-item expanded "><a href="../advanced/provisioning.html"><strong aria-hidden="true">7.</strong> Provisioning</a></li><li class="chapter-item expanded "><a href="../advanced/workers.html"><strong aria-hidden="true">8.</strong> Workers</a></li><li class="chapter-item expanded "><a href="../advanced/encryption.html"><strong aria-hidden="true">9.</strong> 🔒 Encryption</a></li><li class="chapter-item expanded "><a href="../advanced/widgets.html"><strong aria-hidden="true">10.</strong> 🪀 Widgets</a></li><li class="chapter-item expanded "><a href="../advanced/service_bots.html"><strong aria-hidden="true">11.</strong> Service Bots</a></li></ol> </div>
|
||
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
</nav>
|
||
|
||
<div id="page-wrapper" class="page-wrapper">
|
||
|
||
<div class="page">
|
||
|
||
<div id="menu-bar-hover-placeholder"></div>
|
||
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
<div class="left-buttons">
|
||
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
<i class="fa fa-bars"></i>
|
||
</button>
|
||
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
<i class="fa fa-paint-brush"></i>
|
||
</button>
|
||
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
</ul>
|
||
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
<i class="fa fa-search"></i>
|
||
</button>
|
||
</div>
|
||
|
||
<h1 class="menu-title">Matrix Hookshot</h1>
|
||
|
||
<div class="right-buttons">
|
||
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
<i id="print-button" class="fa fa-print"></i>
|
||
</a>
|
||
<a href="https://github.com/matrix-org/matrix-hookshot" title="Git repository" aria-label="Git repository">
|
||
<i id="git-repository-button" class="fa fa-github"></i>
|
||
</a>
|
||
<a href="https://github.com/matrix-org/matrix-hookshot/edit/main/docs/setup/sample-configuration.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="search-wrapper" class="hidden">
|
||
<form id="searchbar-outer" class="searchbar-outer">
|
||
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
</form>
|
||
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
<div id="searchresults-header" class="searchresults-header"></div>
|
||
<ul id="searchresults">
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
<script type="text/javascript">
|
||
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
});
|
||
</script>
|
||
|
||
<div id="content" class="content">
|
||
<main>
|
||
<h1 id="sample-configuration"><a class="header" href="#sample-configuration">Sample Configuration</a></h1>
|
||
<p>Below is a sample bridge configuration file. The configuration file
|
||
can be tweaked to change the behaviour of your bridge. A bridge of the server is
|
||
required to apply any changes made to this file.</p>
|
||
<pre><code class="language-yaml"># This is an example configuration file
|
||
|
||
bridge:
|
||
# Basic homeserver configuration
|
||
|
||
domain: example.com
|
||
url: http://localhost:8008
|
||
mediaUrl: https://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
|
||
hotlinkIssues:
|
||
prefix: "#"
|
||
userIdPrefix:
|
||
# (Optional) Prefix used when creating ghost users for GitHub accounts.
|
||
|
||
_github_
|
||
gitlab:
|
||
# (Optional) Configure this to enable GitLab support
|
||
|
||
instances:
|
||
gitlab.com:
|
||
url: https://gitlab.com
|
||
webhook:
|
||
secret: secrettoken
|
||
publicUrl: https://example.com/hookshot/
|
||
userIdPrefix:
|
||
# (Optional) Prefix used when creating ghost users for GitLab accounts.
|
||
|
||
_gitlab_
|
||
commentDebounceMs:
|
||
# (Optional) Aggregate comments by waiting this many miliseconds before posting them to Matrix. Defaults to 5000 (5 seconds)
|
||
|
||
5000
|
||
figma:
|
||
# (Optional) Configure this to enable Figma support
|
||
|
||
publicUrl: https://example.com/hookshot/
|
||
instances:
|
||
your-instance:
|
||
teamId: your-team-id
|
||
accessToken: your-personal-access-token
|
||
passcode: your-webhook-passcode
|
||
jira:
|
||
# (Optional) Configure this to enable Jira support. Only specify `url` if you are using a On Premise install (i.e. not atlassian.com)
|
||
|
||
webhook:
|
||
# Webhook settings for JIRA
|
||
|
||
secret: secrettoken
|
||
oauth:
|
||
# (Optional) OAuth settings for connecting users to JIRA. See documentation for more information
|
||
|
||
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
|
||
enableHttpGet: false
|
||
urlPrefix: https://example.com/webhook/
|
||
userIdPrefix: _webhooks_
|
||
allowJsTransformationFunctions: false
|
||
waitForComplete: false
|
||
feeds:
|
||
# (Optional) Configure this to enable RSS/Atom feed support
|
||
|
||
enabled: false
|
||
pollConcurrency: 4
|
||
pollIntervalSeconds: 600
|
||
pollTimeoutSeconds: 30
|
||
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: Hookshot Bot
|
||
avatar: mxc://half-shot.uk/2876e89ccade4cb615e210c458e2a7a6883fe17d
|
||
serviceBots:
|
||
# (Optional) Define additional bot users for specific services
|
||
|
||
- localpart: feeds
|
||
displayname: Feeds
|
||
avatar: ./assets/feeds_avatar.png
|
||
prefix: "!feeds"
|
||
service: feeds
|
||
metrics:
|
||
# (Optional) Prometheus metrics support
|
||
|
||
enabled: true
|
||
queue:
|
||
# (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.
|
||
|
||
monolithic: true
|
||
port: 6379
|
||
host: localhost
|
||
logging:
|
||
# (Optional) Logging settings. You can have a severity debug,info,warn,error
|
||
|
||
level: info
|
||
colorize: true
|
||
json: false
|
||
timestampFormat: HH:mm:ss:SSS
|
||
widgets:
|
||
# (Optional) EXPERIMENTAL support for complimentary widgets
|
||
|
||
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
|
||
publicUrl: https://example.com/widgetapi/v1/static/
|
||
branding:
|
||
widgetTitle: Hookshot Configuration
|
||
sentry:
|
||
# (Optional) Configure Sentry error reporting
|
||
|
||
dsn: https://examplePublicKey@o0.ingest.sentry.io/0
|
||
environment: production
|
||
permissions:
|
||
# (Optional) Permissions for using the bridge. See docs/setup.md#permissions for help
|
||
|
||
- actor: example.com
|
||
services:
|
||
- service: "*"
|
||
level: admin
|
||
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
|
||
- port: 9002
|
||
bindAddress: 0.0.0.0
|
||
resources:
|
||
- widgets
|
||
|
||
</code></pre>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="../setup.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<i class="fa fa-angle-left"></i>
|
||
</a>
|
||
|
||
<a rel="next" href="../setup/feeds.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<i class="fa fa-angle-right"></i>
|
||
</a>
|
||
|
||
<div style="clear: both"></div>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
<a rel="prev" href="../setup.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<i class="fa fa-angle-left"></i>
|
||
</a>
|
||
|
||
<a rel="next" href="../setup/feeds.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<i class="fa fa-angle-right"></i>
|
||
</a>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
window.playground_copyable = true;
|
||
</script>
|
||
|
||
|
||
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
||
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
||
<!-- Custom JS scripts -->
|
||
<script type="text/javascript" src="../docs/_site/main.js"></script>
|
||
<script type="text/javascript" src="../docs/_site/version.js"></script>
|
||
|
||
|
||
</body>
|
||
</html>
|