Raw YAML - Releases: latest, v26.04, v25.11, v25.10
1# Network-specific config options
2network:
3 # Displayname template for SMS users. Available variables:
4 # .Name - same as phone number in most cases
5 # .Contact.Name - name from contact list
6 # .Contact.FirstName - first name from contact list
7 # .PhoneNumber
8 displayname_template: "{{ or .Contact.Name .Name }}"
9
10
11# Config options that affect the central bridge module.
12bridge:
13 # The prefix for commands. Only required in non-management rooms.
14 command_prefix: '!gv'
15 # Should the bridge create a space for each login containing the rooms that account is in?
16 personal_filtering_spaces: true
17 # Whether the bridge should set names and avatars explicitly for DM portals.
18 # This is only necessary when using clients that don't support MSC4171.
19 private_chat_portal_meta: true
20 # Should events be handled asynchronously within portal rooms?
21 # If true, events may end up being out of order, but slow events won't block other ones.
22 # This is not yet safe to use.
23 async_events: false
24 # Should every user have their own portals rather than sharing them?
25 # By default, users who are in the same group on the remote network will be
26 # in the same Matrix room bridged to that group. If this is set to true,
27 # every user will get their own Matrix room instead.
28 # SETTING THIS IS IRREVERSIBLE AND POTENTIALLY DESTRUCTIVE IF PORTALS ALREADY EXIST.
29 split_portals: false
30 # Should the bridge resend `m.bridge` events to all portals on startup?
31 resend_bridge_info: false
32 # Should `m.bridge` events be sent without a state key?
33 # By default, the bridge uses a unique key that won't conflict with other bridges.
34 no_bridge_info_state_key: false
35 # Should bridge connection status be sent to the management room as `m.notice` events?
36 # These contain the same data that can be posted to an external HTTP server using homeserver -> status_endpoint.
37 # Allowed values: none, errors, all
38 bridge_status_notices: errors
39 # How long after an unknown error should the bridge attempt a full reconnect?
40 # Must be at least 1 minute. The bridge will add an extra ±20% jitter to this value.
41 unknown_error_auto_reconnect: null
42 # Maximum number of times to do the auto-reconnect above.
43 # The counter is per login, but is never reset except on logout and restart.
44 unknown_error_max_auto_reconnects: 10
45
46 # Should leaving Matrix rooms be bridged as leaving groups on the remote network?
47 bridge_matrix_leave: false
48 # Should `m.notice` messages be bridged?
49 bridge_notices: false
50 # Should room tags only be synced when creating the portal? Tags mean things like favorite/pin and archive/low priority.
51 # Tags currently can't be synced back to the remote network, so a continuous sync means tagging from Matrix will be undone.
52 tag_only_on_create: true
53 # List of tags to allow bridging. If empty, no tags will be bridged.
54 only_bridge_tags: [m.favourite, m.lowpriority]
55 # Should room mute status only be synced when creating the portal?
56 # Like tags, mutes can't currently be synced back to the remote network.
57 mute_only_on_create: true
58 # Should the bridge check the db to ensure that incoming events haven't been handled before
59 deduplicate_matrix_messages: false
60 # Should cross-room reply metadata be bridged?
61 # Most Matrix clients don't support this and servers may reject such messages too.
62 cross_room_replies: false
63 # If a state event fails to bridge, should the bridge revert any state changes made by that event?
64 revert_failed_state_changes: false
65 # In portals with no relay set, should Matrix users be kicked if they're
66 # not logged into an account that's in the remote chat?
67 kick_matrix_users: true
68 # Should the bridge listen to com.beeper.state_request events?
69 # This is not necessary for anything outside of Beeper.
70 enable_send_state_requests: false
71 # Should the com.beeper.bridge.identifiers list in global ghost profiles include phone numbers?
72 phone_numbers_in_profile: false
73
74 # What should be done to portal rooms when a user logs out or is logged out?
75 # Permitted values:
76 # nothing - Do nothing, let the user stay in the portals
77 # kick - Remove the user from the portal rooms, but don't delete them
78 # unbridge - Remove all ghosts in the room and disassociate it from the remote chat
79 # delete - Remove all ghosts and users from the room (i.e. delete it)
80 cleanup_on_logout:
81 # Should cleanup on logout be enabled at all?
82 enabled: false
83 # Settings for manual logouts (explicitly initiated by the Matrix user)
84 manual:
85 # Action for private portals which will never be shared with other Matrix users.
86 private: nothing
87 # Action for portals with a relay user configured.
88 relayed: nothing
89 # Action for portals which may be shared, but don't currently have any other Matrix users.
90 shared_no_users: nothing
91 # Action for portals which have other logged-in Matrix users.
92 shared_has_users: nothing
93 # Settings for credentials being invalidated (initiated by the remote network, possibly through user action).
94 # Keys have the same meanings as in the manual section.
95 bad_credentials:
96 private: nothing
97 relayed: nothing
98 shared_no_users: nothing
99 shared_has_users: nothing
100
101 # Settings for relay mode
102 relay:
103 # Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
104 # authenticated user into a relaybot for that chat.
105 enabled: false
106 # Should only admins be allowed to set themselves as relay users?
107 # If true, non-admins can only set users listed in default_relays as relays in a room.
108 admin_only: true
109 # Should default relays be preferred when an explicit login ID isn't specified even if the user is logged in?
110 # This applies to the set-relay and bridge commands sent by any user, including admins.
111 prefer_default: true
112 # Should non-admins be allowed to use the bridge and sync-chat commands via default relays specified below?
113 allow_bridge: true
114 # List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
115 default_relays: []
116 # The formats to use when sending messages via the relaybot.
117 # Available variables:
118 # .Sender.UserID - The Matrix user ID of the sender.
119 # .Sender.Displayname - The display name of the sender (if set).
120 # .Sender.RequiresDisambiguation - Whether the sender's name may be confused with the name of another user in the room.
121 # .Sender.DisambiguatedName - The disambiguated name of the sender. This will be the displayname if set,
122 # plus the user ID in parentheses if the displayname is not unique.
123 # If the displayname is not set, this is just the user ID.
124 # .Message - The `formatted_body` field of the message.
125 # .Caption - The `formatted_body` field of the message, if it's a caption. Otherwise an empty string.
126 # .FileName - The name of the file being sent.
127 message_formats:
128 m.text: "<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}"
129 m.notice: "<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}"
130 m.emote: "* <b>{{ .Sender.DisambiguatedName }}</b> {{ .Message }}"
131 m.file: "<b>{{ .Sender.DisambiguatedName }}</b> sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}"
132 m.image: "<b>{{ .Sender.DisambiguatedName }}</b> sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}"
133 m.audio: "<b>{{ .Sender.DisambiguatedName }}</b> sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}"
134 m.video: "<b>{{ .Sender.DisambiguatedName }}</b> sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}"
135 m.location: "<b>{{ .Sender.DisambiguatedName }}</b> sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}"
136 # For networks that support per-message displaynames (i.e. Slack and Discord), the template for those names.
137 # This has all the Sender variables available under message_formats (but without the .Sender prefix).
138 # Note that you need to manually remove the displayname from message_formats above.
139 displayname_format: "{{ .DisambiguatedName }}"
140
141 # Filter for automatically creating portals.
142 portal_create_filter:
143 # The mode for filtering, either `deny` or `allow`
144 mode: deny
145 # The list of portal IDs to deny or allow depending on the mode config.
146 # Items here can either be the plain portal ID as a string, or an object with `id` and `receiver` fields.
147 # The receiver field is necessary if you want to target a specific DM portal for example.
148 list: []
149 # A list of user login IDs from which to always deny creating portals.
150 # This is meant to be used with default relays, such that the relay bot
151 # being added to a group wouldn't automatically trigger portal creation.
152 always_deny_from_login: []
153
154 # Permissions for using the bridge.
155 # Permitted values:
156 # relay - Talk through the relaybot (if enabled), no access otherwise
157 # commands - Access to use commands in the bridge, but not login.
158 # user - Access to use the bridge with puppeting.
159 # admin - Full access, user level with some additional administration tools.
160 # Permitted keys:
161 # * - All Matrix users
162 # domain - All users on that homeserver
163 # mxid - Specific user
164 permissions:
165 "*": relay
166 "example.com": user
167 "@admin:example.com": admin
168
169# Config for the bridge's database.
170database:
171 # The database type. "sqlite3-fk-wal" and "postgres" are supported.
172 type: postgres
173 # The database URI.
174 # SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
175 # https://github.com/mattn/go-sqlite3#connection-string
176 # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
177 # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
178 uri: postgres://user:password@host/database?sslmode=disable
179 # Maximum number of connections.
180 max_open_conns: 5
181 max_idle_conns: 1
182 # Maximum connection idle time and lifetime before they're closed. Disabled if null.
183 # Parsed with https://pkg.go.dev/time#ParseDuration
184 max_conn_idle_time: null
185 max_conn_lifetime: null
186
187# Homeserver details.
188homeserver:
189 # The address that this appservice can use to connect to the homeserver.
190 # Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
191 # but https also works if they run on different machines.
192 address: http://example.localhost:8008
193 # The domain of the homeserver (also known as server_name, used for MXIDs, etc).
194 domain: example.com
195
196 # What software is the homeserver running?
197 # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
198 software: standard
199 # The URL to push real-time bridge status to.
200 # If set, the bridge will make POST requests to this URL whenever a user's remote network connection state changes.
201 # The bridge will use the appservice as_token to authorize requests.
202 status_endpoint:
203 # Endpoint for reporting per-message status.
204 # If set, the bridge will make POST requests to this URL when processing a message from Matrix.
205 # It will make one request when receiving the message (step BRIDGE), one after decrypting if applicable
206 # (step DECRYPTED) and one after sending to the remote network (step REMOTE). Errors will also be reported.
207 # The bridge will use the appservice as_token to authorize requests.
208 message_send_checkpoint_endpoint:
209 # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
210 async_media: false
211
212 # Should the bridge use a websocket for connecting to the homeserver?
213 # The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
214 # mautrix-asmux (deprecated), and hungryserv (proprietary).
215 websocket: false
216 # How often should the websocket be pinged? Pinging will be disabled if this is zero.
217 ping_interval_seconds: 0
218
219# Application service host/registration related details.
220# Changing these values requires regeneration of the registration (except when noted otherwise)
221appservice:
222 # The address that the homeserver can use to connect to this appservice.
223 # Like the homeserver address, a local non-https address is recommended when the bridge is on the same machine.
224 # If the bridge is elsewhere, you must secure the connection yourself (e.g. with https or wireguard)
225 # If you want to use https, you need to use a reverse proxy. The bridge does not have TLS support built in.
226 address: http://localhost:29338
227 # A public address that external services can use to reach this appservice.
228 # This is only needed for things like public media. A reverse proxy is generally necessary when using this field.
229 # This value doesn't affect the registration file.
230 public_address: https://bridge.example.com
231
232 # The hostname and port where this appservice should listen.
233 # For Docker, you generally have to change the hostname to 0.0.0.0.
234 hostname: 127.0.0.1
235 port: 29338
236
237 # The unique ID of this appservice.
238 id: gvoice
239 # Appservice bot details.
240 bot:
241 # Username of the appservice bot.
242 username: gvoicebot
243 # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
244 # to leave display name/avatar as-is.
245 displayname: Google Voice bridge bot
246 avatar: mxc://maunium.net/VOPtYGBzHLRfPTEzGgNMpeKo
247
248 # Whether to receive ephemeral events via appservice transactions.
249 ephemeral_events: true
250 # Should incoming events be handled asynchronously?
251 # This may be necessary for large public instances with lots of messages going through.
252 # However, messages will not be guaranteed to be bridged in the same order they were sent in.
253 # This value doesn't affect the registration file.
254 async_transactions: false
255
256 # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
257 as_token: "This value is generated when generating the registration"
258 hs_token: "This value is generated when generating the registration"
259
260 # Localpart template of MXIDs for remote users.
261 # {{.}} is replaced with the internal ID of the user.
262 username_template: gvoice_{{.}}
263
264# Config options that affect the Matrix connector of the bridge.
265matrix:
266 # Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
267 message_status_events: false
268 # Whether the bridge should send a read receipt after successfully bridging a message.
269 delivery_receipts: false
270 # Whether the bridge should send error notices via m.notice events when a message fails to bridge.
271 message_error_notices: true
272 # Whether the bridge should update the m.direct account data event when double puppeting is enabled.
273 sync_direct_chat_list: true
274 # Whether created rooms should have federation enabled. If false, created portal rooms
275 # will never be federated. Changing this option requires recreating rooms.
276 federate_rooms: true
277 # The threshold as bytes after which the bridge should roundtrip uploads via the disk
278 # rather than keeping the whole file in memory.
279 upload_file_threshold: 5242880
280 # Should the bridge set additional custom profile info for ghosts?
281 # This can make a lot of requests, as there's no batch profile update endpoint.
282 ghost_extra_profile_info: false
283
284# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
285analytics:
286 # API key to send with tracking requests. Tracking is disabled if this is null.
287 token: null
288 # Address to send tracking requests to.
289 url: https://api.segment.io/v1/track
290 # Optional user ID for tracking events. If null, defaults to using Matrix user ID.
291 user_id: null
292
293# Settings for provisioning API
294provisioning:
295 # Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
296 # or if set to "disable", the provisioning API will be disabled. Must be at least 16 characters.
297 shared_secret: generate
298 # Whether to allow provisioning API requests to be authed using Matrix access tokens.
299 # This follows the same rules as double puppeting to determine which server to contact to check the token,
300 # which means that by default, it only works for users on the same server as the bridge.
301 allow_matrix_auth: true
302 # Enable debug API at /debug with provisioning authentication.
303 debug_endpoints: false
304 # Enable session transfers between bridges. Note that this only validates Matrix or shared secret
305 # auth before passing live network client credentials down in the response.
306 enable_session_transfers: false
307
308# Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks).
309# These settings control whether the bridge will provide such public media access.
310public_media:
311 # Should public media be enabled at all?
312 # The public_address field under the appservice section MUST be set when enabling public media.
313 enabled: false
314 # A key for signing public media URLs.
315 # If set to "generate", a random key will be generated.
316 signing_key: generate
317 # Number of seconds that public media URLs are valid for.
318 # If set to 0, URLs will never expire.
319 expiry: 0
320 # Length of hash to use for public media URLs. Must be between 0 and 32.
321 hash_length: 32
322 # The path prefix for generated URLs. Note that this will NOT change the path where media is actually served.
323 # If you change this, you must configure your reverse proxy to rewrite the path accordingly.
324 path_prefix: /_mautrix/publicmedia
325 # Should the bridge store media metadata in the database in order to support encrypted media and generate shorter URLs?
326 # If false, the generated URLs will just have the MXC URI and a HMAC signature.
327 # The hash_length field will be used to decide the length of the generated URL.
328 # This also allows invalidating URLs by deleting the database entry.
329 use_database: false
330
331# Settings for converting remote media to custom mxc:// URIs instead of reuploading.
332# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
333direct_media:
334 # Should custom mxc:// URIs be used instead of reuploading media?
335 enabled: false
336 # The server name to use for the custom mxc:// URIs.
337 # This server name will effectively be a real Matrix server, it just won't implement anything other than media.
338 # You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
339 server_name: discord-media.example.com
340 # Optionally a custom .well-known response. This defaults to `server_name:443`
341 well_known_response:
342 # Optionally specify a custom prefix for the media ID part of the MXC URI.
343 media_id_prefix:
344 # If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916
345 # media download redirects if the requester supports it. Optionally, you can force redirects
346 # and not allow proxying at all by setting this to false.
347 # This option does nothing if the remote network does not support media downloads over HTTP.
348 allow_proxy: true
349 # Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
350 # This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
351 server_key: generate
352
353# Settings for backfilling messages.
354# Note that the exact way settings are applied depends on the network connector.
355# See https://docs.mau.fi/bridges/general/backfill.html for more details.
356backfill:
357 # Whether to do backfilling at all.
358 enabled: false
359 # Maximum number of messages to backfill in empty rooms.
360 # If this is zero or negative, backfill will be disabled in new rooms.
361 max_initial_messages: 50
362 # Maximum number of missed messages to backfill after bridge restarts.
363 max_catchup_messages: 500
364 # If a backfilled chat is older than this number of hours,
365 # mark it as read even if it's unread on the remote network.
366 unread_hours_threshold: 720
367 # Settings for backfilling threads within other backfills.
368 threads:
369 # Maximum number of messages to backfill in a new thread.
370 max_initial_messages: 50
371 # Settings for the backwards backfill queue. This only applies when connecting to
372 # Beeper as standard Matrix servers don't support inserting messages into history.
373 queue:
374 # Should the backfill queue be enabled?
375 enabled: false
376 # Should manual calls to backfill queue tasks be allowed?
377 manual: false
378 # Number of messages to backfill in one batch.
379 batch_size: 100
380 # Delay between batches in seconds.
381 batch_delay: 20
382 # Maximum number of batches to backfill per portal.
383 # If set to -1, all available messages will be backfilled.
384 max_batches: -1
385 # Optional network-specific overrides for max batches.
386 # Interpretation of this field depends on the network connector.
387 max_batches_override: {}
388
389# Settings for enabling double puppeting
390double_puppet:
391 # Servers to always allow double puppeting from.
392 # This is only for other servers and should NOT contain the server the bridge is on.
393 servers:
394 anotherserver.example.org: https://matrix.anotherserver.example.org
395 # Whether to allow client API URL discovery for other servers. When using this option,
396 # users on other servers can use double puppeting even if their server URLs aren't
397 # explicitly added to the servers map above.
398 allow_discovery: false
399 # Shared secrets for automatic double puppeting.
400 # See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
401 secrets:
402 example.com: as_token:foobar
403
404# End-to-bridge encryption support options.
405#
406# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
407encryption:
408 # Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
409 allow: false
410 # Whether to force-enable encryption in all bridged rooms.
411 default: false
412 # Whether to require all messages to be encrypted and drop any unencrypted messages.
413 require: false
414 # Whether to use MSC3202/MSC4203 instead of /sync long polling for receiving encryption-related data.
415 # This is an experimental option, see the docs for more info.
416 # Changing this option requires updating the appservice registration file.
417 appservice: false
418 # Whether to use MSC4190 instead of appservice login to create the bridge bot device.
419 # Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
420 # Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
421 msc4190: false
422 # Whether to encrypt reactions and reply metadata as per MSC4392.
423 # This is not supported by most clients.
424 msc4392: false
425 # Should the bridge bot generate a recovery key and cross-signing keys and verify itself?
426 # Note that without the latest version of MSC4190, this will fail if you reset the bridge database.
427 # The generated recovery key will be saved in the kv_store table under `recovery_key`.
428 self_sign: false
429 # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
430 # You must use a client that supports requesting keys from other users to use this feature.
431 allow_key_sharing: true
432 # Pickle key for encrypting encryption keys in the bridge database.
433 # If set to generate, a random key will be generated.
434 pickle_key: generate
435 # Options for deleting megolm sessions from the bridge.
436 delete_keys:
437 # Beeper-specific: delete outbound sessions when hungryserv confirms
438 # that the user has uploaded the key to key backup.
439 delete_outbound_on_ack: false
440 # Don't store outbound sessions in the inbound table.
441 dont_store_outbound: false
442 # Ratchet megolm sessions forward after decrypting messages.
443 ratchet_on_decrypt: false
444 # Delete fully used keys (index >= max_messages) after decrypting messages.
445 delete_fully_used_on_decrypt: false
446 # Delete previous megolm sessions from same device when receiving a new one.
447 delete_prev_on_new_session: false
448 # Delete megolm sessions received from a device when the device is deleted.
449 delete_on_device_delete: false
450 # Periodically delete megolm sessions when 2x max_age has passed since receiving the session.
451 periodically_delete_expired: false
452 # Delete inbound megolm sessions that don't have the received_at field used for
453 # automatic ratcheting and expired session deletion. This is meant as a migration
454 # to delete old keys prior to the bridge update.
455 delete_outdated_inbound: false
456 # What level of device verification should be required from users?
457 #
458 # Valid levels:
459 # unverified - Send keys to all device in the room.
460 # cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys.
461 # cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes).
462 # cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot.
463 # Note that creating user signatures from the bridge bot is not currently possible.
464 # verified - Require manual per-device verification
465 # (currently only possible by modifying the `trust` column in the `crypto_device` database table).
466 verification_levels:
467 # Minimum level for which the bridge should send keys to when bridging messages from the remote network to Matrix.
468 receive: unverified
469 # Minimum level that the bridge should accept for incoming Matrix messages.
470 send: unverified
471 # Minimum level that the bridge should require for accepting key requests.
472 share: cross-signed-tofu
473 # Options for Megolm room key rotation. These options allow you to configure the m.room.encryption event content.
474 # See https://spec.matrix.org/v1.10/client-server-api/#mroomencryption for more information about that event.
475 rotation:
476 # Enable custom Megolm room key rotation settings. Note that these
477 # settings will only apply to rooms created after this option is set.
478 enable_custom: false
479 # The maximum number of milliseconds a session should be used
480 # before changing it. The Matrix spec recommends 604800000 (a week)
481 # as the default.
482 milliseconds: 604800000
483 # The maximum number of messages that should be sent with a given a
484 # session before changing it. The Matrix spec recommends 100 as the
485 # default.
486 messages: 100
487 # Disable rotating keys when a user's devices change?
488 # You should not enable this option unless you understand all the implications.
489 disable_device_change_key_rotation: false
490
491# Prefix for environment variables. All variables with this prefix must map to valid config fields.
492# Nesting in variable names is represented with a dot (.).
493# If there are no dots in the name, two underscores (__) are replaced with a dot.
494#
495# e.g. if the prefix is set to `BRIDGE_`, then `BRIDGE_APPSERVICE__AS_TOKEN` will set appservice.as_token.
496# `BRIDGE_appservice.as_token` would work as well, but can't be set in a shell as easily.
497#
498# If this is null, reading config fields from environment will be disabled.
499env_config_prefix: null
500
501# Logging config. See https://github.com/tulir/zeroconfig for details.
502logging:
503 min_level: debug
504 writers:
505 - type: stdout
506 format: pretty-colored
507 - type: file
508 format: json
509 filename: ./logs/bridge.log
510 max_size: 100
511 max_backups: 10
512 compress: false