Skip to content

Commit 1e2aea0

Browse files
committed
update default config (mostly sections moving around)
1 parent 4ad5ade commit 1e2aea0

File tree

1 file changed

+49
-49
lines changed

1 file changed

+49
-49
lines changed

config.sample.yml

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# This is an example configuration file
22

3-
logging:
4-
# Logging settings. You can have a severity debug,info,warn,error
5-
level: info
6-
colorize: true
7-
json: false
8-
timestampFormat: HH:mm:ss:SSS
93
bridge:
104
# Basic homeserver configuration
115
domain: example.com
126
url: http://localhost:8008
137
mediaUrl: https://example.com
148
port: 9993
159
bindAddress: 127.0.0.1
10+
logging:
11+
# Logging settings. You can have a severity debug,info,warn,error
12+
level: info
13+
colorize: true
14+
json: false
15+
timestampFormat: HH:mm:ss:SSS
1616
passFile:
1717
# A passkey used to encrypt tokens stored inside the bridge.
1818
# Run openssl genpkey -out passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:4096 to generate
@@ -37,6 +37,25 @@ listeners:
3737
resources:
3838
- widgets
3939

40+
#cache:
41+
# # (Optional) Cache options for large scale deployments.
42+
# # For encryption to work, this must be configured.
43+
# redisUri: redis://localhost:6379
44+
45+
#encryption:
46+
# # (Optional) Configuration for encryption support in the bridge.
47+
# # If omitted, encryption support will be disabled.
48+
# storagePath:
49+
# # Path to the directory used to store encryption files. These files must be persist between restarts of the service.
50+
# ./cryptostore
51+
52+
#permissions:
53+
# # (Optional) Permissions for using the bridge. See docs/setup.md#permissions for help
54+
# - actor: example.com
55+
# services:
56+
# - service: "*"
57+
# level: admin
58+
4059
#github:
4160
# # (Optional) Configure this to enable GitHub support
4261
# auth:
@@ -75,15 +94,6 @@ listeners:
7594
# # (Optional) Aggregate comments by waiting this many miliseconds before posting them to Matrix. Defaults to 5000 (5 seconds)
7695
# 5000
7796

78-
#figma:
79-
# # (Optional) Configure this to enable Figma support
80-
# publicUrl: https://example.com/hookshot/
81-
# instances:
82-
# your-instance:
83-
# teamId: your-team-id
84-
# accessToken: your-personal-access-token
85-
# passcode: your-webhook-passcode
86-
8797
#jira:
8898
# # (Optional) Configure this to enable Jira support. Only specify `url` if you are using a On Premise install (i.e. not atlassian.com)
8999
# webhook:
@@ -101,25 +111,30 @@ listeners:
101111

102112
# enabled: false
103113
# outbound: false
104-
# enableHttpGet: false
105-
# sendExpiryNotice: false
106-
# requireExpiryTime: false
107114
# urlPrefix: https://example.com/webhook/
108115
# userIdPrefix: _webhooks_
109116
# allowJsTransformationFunctions: false
110117
# waitForComplete: false
118+
# enableHttpGet: false
119+
# sendExpiryNotice: false
120+
# requireExpiryTime: false
111121
# maxExpiryTime: 30d
112122

123+
#figma:
124+
# # (Optional) Configure this to enable Figma support
125+
# publicUrl: https://example.com/hookshot/
126+
# instances:
127+
# your-instance:
128+
# teamId: your-team-id
129+
# accessToken: your-personal-access-token
130+
# passcode: your-webhook-passcode
131+
113132
#feeds:
114133
# # (Optional) Configure this to enable RSS/Atom feed support
115134
# enabled: false
116-
# pollConcurrency: 4
117135
# pollIntervalSeconds: 600
118136
# pollTimeoutSeconds: 30
119-
120-
#provisioning:
121-
# # (Optional) Provisioning API for integration managers
122-
# secret: "!secretToken"
137+
# pollConcurrency: 4
123138

124139
#bot:
125140
# # (Optional) Define profile information for the bot user
@@ -134,25 +149,12 @@ listeners:
134149
# prefix: "!feeds"
135150
# service: feeds
136151

137-
#metrics:
138-
# # (Optional) Prometheus metrics support
139-
# enabled: true
140-
141-
#cache:
142-
# # (Optional) Cache options for large scale deployments.
143-
# # For encryption to work, this must be configured.
144-
# redisUri: redis://localhost:6379
145-
146-
#encryption:
147-
# # (Optional) Configuration for encryption support in the bridge.
148-
# # If omitted, encryption support will be disabled.
149-
# storagePath:
150-
# # Path to the directory used to store encryption files. These files must be persist between restarts of the service.
151-
# ./cryptostore
152-
153152
#widgets:
154153
# # (Optional) EXPERIMENTAL support for complimentary widgets
155154
# addToAdminRooms: false
155+
# publicUrl: https://example.com/widgetapi/v1/static/
156+
# roomSetupWidget:
157+
# addOnInvite: false
156158
# disallowedIpRanges:
157159
# - 127.0.0.0/8
158160
# - 10.0.0.0/8
@@ -173,23 +175,21 @@ listeners:
173175
# - 2001:db8::/32
174176
# - ff00::/8
175177
# - fec0::/10
176-
# roomSetupWidget:
177-
# addOnInvite: false
178-
# publicUrl: https://example.com/widgetapi/v1/static/
179178
# branding:
180179
# widgetTitle: Hookshot Configuration
181180

181+
#provisioning:
182+
# # (Optional) Provisioning API for integration managers
183+
# secret: "!secretToken"
184+
185+
#metrics:
186+
# # (Optional) Prometheus metrics support
187+
# enabled: true
188+
182189
#sentry:
183190
# # (Optional) Configure Sentry error reporting
184191
# dsn: https://[email protected]/0
185192
# environment: production
186193

187-
#permissions:
188-
# # (Optional) Permissions for using the bridge. See docs/setup.md#permissions for help
189-
# - actor: example.com
190-
# services:
191-
# - service: "*"
192-
# level: admin
193-
194194

195195

0 commit comments

Comments
 (0)