|
| 1 | +# Matrix Synapse Configuration |
| 2 | +# Place this file in: ./config/matrix/homeserver.yaml |
| 3 | + |
| 4 | +## Server ## |
| 5 | +server_name: "matrix.localhost" # Change to your domain |
| 6 | +pid_file: /data/homeserver.pid |
| 7 | +web_client_location: https://app.element.io/ |
| 8 | + |
| 9 | +# Public baseurl for when a client needs to access the server from outside the docker network |
| 10 | +public_baseurl: https://matrix.localhost/ # Change to your domain |
| 11 | + |
| 12 | +# Set the soft limit on the number of file descriptors synapse can use |
| 13 | +# Zero is used to indicate synapse should set the soft limit to the hard limit |
| 14 | +soft_file_limit: 0 |
| 15 | + |
| 16 | +# Presence tracking allows users to see the state (e.g online/offline) of other users |
| 17 | +presence: |
| 18 | + enabled: true |
| 19 | + |
| 20 | +## Listeners ## |
| 21 | +listeners: |
| 22 | + # Main HTTPS listener |
| 23 | + # For when matrix traffic is sent directly to synapse |
| 24 | + - port: 8008 |
| 25 | + tls: false |
| 26 | + type: http |
| 27 | + x_forwarded: true |
| 28 | + bind_addresses: ['0.0.0.0'] |
| 29 | + |
| 30 | + resources: |
| 31 | + - names: [client, federation] |
| 32 | + compress: false |
| 33 | + |
| 34 | + # Federation listener |
| 35 | + - port: 8448 |
| 36 | + tls: false |
| 37 | + type: http |
| 38 | + x_forwarded: true |
| 39 | + bind_addresses: ['0.0.0.0'] |
| 40 | + |
| 41 | + resources: |
| 42 | + - names: [federation] |
| 43 | + |
| 44 | +## Database ## |
| 45 | +database: |
| 46 | + name: psycopg2 |
| 47 | + args: |
| 48 | + user: matrix_user |
| 49 | + password: "REPLACE_WITH_SECRET" # This will be replaced by entrypoint script |
| 50 | + database: matrix_synapse |
| 51 | + host: matrix-postgres |
| 52 | + port: 5432 |
| 53 | + cp_min: 5 |
| 54 | + cp_max: 10 |
| 55 | + |
| 56 | +## Logging ## |
| 57 | +log_config: "/data/matrix-synapse.log.config" |
| 58 | + |
| 59 | +## Media Store ## |
| 60 | +media_store_path: /data/media_store |
| 61 | + |
| 62 | +# Maximum allowed upload size in bytes |
| 63 | +max_upload_size: 100M |
| 64 | + |
| 65 | +# Maximum number of pixels in an image |
| 66 | +max_image_pixels: 32M |
| 67 | + |
| 68 | +# Whether to generate new thumbnails on the fly |
| 69 | +dynamic_thumbnails: true |
| 70 | + |
| 71 | +# List of thumbnails to pre-generate |
| 72 | +thumbnail_sizes: |
| 73 | + - width: 32 |
| 74 | + height: 32 |
| 75 | + method: crop |
| 76 | + - width: 96 |
| 77 | + height: 96 |
| 78 | + method: crop |
| 79 | + - width: 320 |
| 80 | + height: 240 |
| 81 | + method: scale |
| 82 | + - width: 640 |
| 83 | + height: 480 |
| 84 | + method: scale |
| 85 | + - width: 800 |
| 86 | + height: 600 |
| 87 | + method: scale |
| 88 | + |
| 89 | +# Retention policy for uploaded media |
| 90 | +media_retention: |
| 91 | + remote_media_lifetime: 90d |
| 92 | + |
| 93 | +## Registration ## |
| 94 | +enable_registration: false |
| 95 | +enable_registration_without_verification: false |
| 96 | + |
| 97 | +# Require email for registration |
| 98 | +registrations_require_3pid: |
| 99 | + - email |
| 100 | + |
| 101 | +# Allowed email domains for registration |
| 102 | +allowed_local_3pids: |
| 103 | + - medium: email |
| 104 | + pattern: '.*' |
| 105 | + |
| 106 | +# Registration shared secret for creating users via command line |
| 107 | +# Generate with: openssl rand -base64 32 |
| 108 | +registration_shared_secret: "GENERATE_AND_REPLACE_THIS" |
| 109 | + |
| 110 | +## Captcha ## |
| 111 | +enable_registration_captcha: false |
| 112 | + |
| 113 | +## Metrics ## |
| 114 | +enable_metrics: false |
| 115 | +report_stats: false |
| 116 | + |
| 117 | +## API Configuration ## |
| 118 | +room_prejoin_state: |
| 119 | + disable_default_event_types: false |
| 120 | + additional_event_types: |
| 121 | + - "m.room.encryption" |
| 122 | + |
| 123 | +## Signing Keys ## |
| 124 | +signing_key_path: "/data/matrix-synapse.signing.key" |
| 125 | +trusted_key_servers: |
| 126 | + - server_name: "matrix.org" |
| 127 | + |
| 128 | +## Single Sign-On / SAML / CAS ## |
| 129 | +# Uncomment and configure if needed |
| 130 | +# saml2_config: |
| 131 | +# sp_config: |
| 132 | +# metadata: |
| 133 | +# remote: |
| 134 | +# - url: https://your-idp.com/metadata |
| 135 | + |
| 136 | +## Password Policy ## |
| 137 | +password_config: |
| 138 | + enabled: true |
| 139 | + policy: |
| 140 | + minimum_length: 10 |
| 141 | + require_digit: true |
| 142 | + require_symbol: true |
| 143 | + require_lowercase: true |
| 144 | + require_uppercase: true |
| 145 | + |
| 146 | +## User Directory ## |
| 147 | +user_directory: |
| 148 | + enabled: true |
| 149 | + search_all_users: false |
| 150 | + prefer_local_users: true |
| 151 | + |
| 152 | +## Room Directory ## |
| 153 | +room_list_publication_rules: |
| 154 | + - alias: "*" |
| 155 | + room_id: "*" |
| 156 | + action: allow |
| 157 | + |
| 158 | +## Push Notifications ## |
| 159 | +push: |
| 160 | + enabled: true |
| 161 | + |
| 162 | +## Ratelimiting ## |
| 163 | +rc_message: |
| 164 | + per_second: 0.2 |
| 165 | + burst_count: 10 |
| 166 | + |
| 167 | +rc_registration: |
| 168 | + per_second: 0.17 |
| 169 | + burst_count: 3 |
| 170 | + |
| 171 | +rc_login: |
| 172 | + address: |
| 173 | + per_second: 0.17 |
| 174 | + burst_count: 3 |
| 175 | + account: |
| 176 | + per_second: 0.17 |
| 177 | + burst_count: 3 |
| 178 | + failed_attempts: |
| 179 | + per_second: 0.17 |
| 180 | + burst_count: 3 |
| 181 | + |
| 182 | +rc_admin_redaction: |
| 183 | + per_second: 1 |
| 184 | + burst_count: 50 |
| 185 | + |
| 186 | +rc_joins: |
| 187 | + local: |
| 188 | + per_second: 0.1 |
| 189 | + burst_count: 10 |
| 190 | + remote: |
| 191 | + per_second: 0.01 |
| 192 | + burst_count: 10 |
| 193 | + |
| 194 | +## Federation ## |
| 195 | +federation_domain_whitelist: [] |
| 196 | +# federation_domain_whitelist: |
| 197 | +# - matrix.org |
| 198 | +# - another-homeserver.com |
| 199 | + |
| 200 | +federation_ip_range_blacklist: |
| 201 | + - '127.0.0.0/8' |
| 202 | + - '10.0.0.0/8' |
| 203 | + - '172.16.0.0/12' |
| 204 | + - '192.168.0.0/16' |
| 205 | + - '100.64.0.0/10' |
| 206 | + - '169.254.0.0/16' |
| 207 | + - '::1/128' |
| 208 | + - 'fe80::/64' |
| 209 | + - 'fc00::/7' |
| 210 | + |
| 211 | +## Caching ## |
| 212 | +caches: |
| 213 | + global_factor: 1.0 |
| 214 | + expire_caches: true |
| 215 | + cache_entry_ttl: 30m |
| 216 | + sync_response_cache_duration: 2m |
| 217 | + |
| 218 | +## Redis for Replication ## |
| 219 | +redis: |
| 220 | + enabled: true |
| 221 | + host: redis |
| 222 | + port: 6379 |
| 223 | + password: "REPLACE_WITH_SECRET" # This will be replaced by entrypoint script |
| 224 | + dbid: 1 |
| 225 | + |
| 226 | +## URL Preview ## |
| 227 | +url_preview_enabled: true |
| 228 | +url_preview_ip_range_blacklist: |
| 229 | + - '127.0.0.0/8' |
| 230 | + - '10.0.0.0/8' |
| 231 | + - '172.16.0.0/12' |
| 232 | + - '192.168.0.0/16' |
| 233 | + - '100.64.0.0/10' |
| 234 | + - '169.254.0.0/16' |
| 235 | + - '::1/128' |
| 236 | + - 'fe80::/64' |
| 237 | + - 'fc00::/7' |
| 238 | + |
| 239 | +url_preview_url_blacklist: [] |
| 240 | + |
| 241 | +max_spider_size: 10M |
| 242 | + |
| 243 | +## Encryption ## |
| 244 | +encryption_enabled_by_default_for_room_type: all |
| 245 | + |
| 246 | +## Experimental Features ## |
| 247 | +experimental_features: |
| 248 | + spaces_enabled: true |
| 249 | + msc3026_enabled: true # Busy presence state |
| 250 | + |
| 251 | +## Turn Server (for VoIP) ## |
| 252 | +# Uncomment and configure if you want VoIP support |
| 253 | +# turn_uris: |
| 254 | +# - "turn:turn.matrix.org?transport=udp" |
| 255 | +# - "turn:turn.matrix.org?transport=tcp" |
| 256 | +# turn_shared_secret: "YOUR_SHARED_SECRET" |
| 257 | +# turn_user_lifetime: 86400000 |
| 258 | +# turn_allow_guests: true |
| 259 | + |
| 260 | +## Retention ## |
| 261 | +retention: |
| 262 | + enabled: false |
| 263 | + default_policy: |
| 264 | + min_lifetime: 1d |
| 265 | + max_lifetime: 1y |
| 266 | + |
| 267 | +## User Consent ## |
| 268 | +user_consent: |
| 269 | + require_at_registration: false |
| 270 | + version: "1.0" |
| 271 | + server_notice_content: |
| 272 | + msgtype: m.text |
| 273 | + body: >- |
| 274 | + To continue using this homeserver you must review and agree to the |
| 275 | + terms and conditions at %(consent_uri)s |
| 276 | +
|
| 277 | +## Stats ## |
| 278 | +stats: |
| 279 | + enabled: false |
| 280 | + |
| 281 | +## Server Notices ## |
| 282 | +server_notices: |
| 283 | + system_mxid_localpart: notices |
| 284 | + system_mxid_display_name: "Server Notices" |
| 285 | + system_mxid_avatar_url: "mxc://matrix.localhost/ServerNoticeAvatar" |
| 286 | + room_name: "Server Notices" |
| 287 | + |
| 288 | +## Email Configuration ## |
| 289 | +# Uncomment and configure for email notifications |
| 290 | +# email: |
| 291 | +# smtp_host: smtp.gmail.com |
| 292 | +# smtp_port: 587 |
| 293 | +# smtp_user: "your-email@gmail.com" |
| 294 | +# smtp_pass: "your-password" |
| 295 | +# require_transport_security: true |
| 296 | +# notif_from: "%(app)s <noreply@matrix.localhost>" |
| 297 | +# app_name: Matrix |
| 298 | +# enable_notifs: true |
| 299 | +# notif_for_new_users: false |
| 300 | +# client_base_url: "https://app.element.io" |
| 301 | +# validation_token_lifetime: 15m |
| 302 | +# invite_client_location: https://app.element.io |
| 303 | + |
| 304 | +## Allow guest access ## |
| 305 | +allow_guest_access: false |
| 306 | + |
| 307 | +## Allow public rooms ## |
| 308 | +allow_public_rooms_without_auth: false |
| 309 | +allow_public_rooms_over_federation: false |
| 310 | + |
| 311 | +## Room Complexity ## |
| 312 | +limit_remote_rooms: |
| 313 | + enabled: true |
| 314 | + complexity: 1.0 |
| 315 | + complexity_error: "This room is too complex." |
| 316 | + |
| 317 | +## Modules ## |
| 318 | +modules: [] |
| 319 | + |
| 320 | +## App Services ## |
| 321 | +app_service_config_files: [] |
| 322 | + |
| 323 | +## Forgotten Room Retention ## |
| 324 | +forgotten_room_retention_period: 7d |
| 325 | + |
| 326 | +## Default Room Version ## |
| 327 | +default_room_version: "9" |
| 328 | + |
| 329 | +## Background Updates ## |
| 330 | +background_updates: |
| 331 | + min_batch_size: 1 |
| 332 | + default_batch_size: 100 |
| 333 | + sleep_enabled: true |
| 334 | + sleep_duration: 1000 |
| 335 | + |
| 336 | +## Admin Contact ## |
| 337 | +admin_contact: 'mailto:admin@matrix.localhost' |
| 338 | + |
| 339 | +## Support Page ## |
| 340 | +# Uncomment to add a support page |
| 341 | +# support: |
| 342 | +# email: 'support@matrix.localhost' |
| 343 | +# mxid: '@support:matrix.localhost' |
0 commit comments