Pirate Charmers Matrix

Learn about configurations >

• allow-public-rooms-federated | boolean

  When true, public rooms are available by default via federation

• allow-public-rooms-unauthed | boolean

  When true, public rooms can be queried without authenticating

• cache-factor | float

  Default: 2.0

  The cache factor influences the amount of system memory used for caching room information. Reducing this number will reduce the amount of memory used for caching, at the expense of performance for common API queries.

• default-room-version | int

  Default: 5

  The default room version to advertise for new rooms

• enable-federation | boolean

  Default: True

  Enable federation, enabled by default. When enabled, port 8448 will listen, including via reverse proxy.

• enable-ircd | boolean

  Enable connecting to this homeserver via IRC, using the matrix-ircd snap. Will use port 6667 for non-TLS and 6697 if TLS is enabled, per RFC7194.

• enable-non-admin-invites | boolean

  When set to true, invites are enabled for non-admin users

• enable-registration | boolean

  Enable public new user registration, disabled by default

• enable-reporting-stats | boolean

  Enable reporting of anonymous stastics to the Matrix project

• enable-room-list-search | boolean

  Enable searching the room list

• enable-search | boolean

  Default: True

  When set to true, indexing and search is enabled.

• enable-tls | boolean

  Enable TLS via ACME. When a reverse proxy is related, this will tell the related reverse proxy to prefer port 443 for the frontend listener.

• enable-user-directory | boolean

  Enable the user directory

• external-domain | string

  This external domain name the server will be accessed from. Defaults to server name. This can be set to a different domain to the server name, for example a subdomain of the server name's domain.

• federation-domain-whitelist | string

  A comma separated list of domains to whitelist for federation

• federation-ip-range-blacklist | string

  A comma seperated list of IP ranges to blacklist from federation

• prefer-internal-ip | boolean

  Prefer the use of IP addresses for reverse proxy and matrix IRCd when contacting the home server, useful if you have non-functional internal DNS

• require-auth-profile-requests | boolean

  Default: True

  When true, requires authentication to request profile information

• server-name | string

  The public server name. This value needs to be set, and once set, can not be changed. This name forms the @domain portion of all matrix users on the home server.

• shared-secret | string

  The shared secret used during registration. Leave blank for it to be autogenerated. The secret can be retrieved via the get-shared-secret action.

• smtp-host | string

  The SMTP host to use when sending notifications.

• smtp-pass | string

  The password, if required, used when logging in to the SMTP host provided.

• smtp-port | string

  Default: 25

  Customise the SMTP port to use when sending notifications.

• smtp-sender | string

  The email address to send notifications from.

• smtp-user | string

  The user account, if required, used when logging in to the SMTP host provided.

• snap_proxy | string

  DEPRECATED. Use snap-http-proxy and snap-https-proxy model configuration settings. HTTP/HTTPS web proxy for Snappy to use when accessing the snap store.

• snap_proxy_url | string

  DEPRECATED. Use snap-store-proxy model configuration setting. The address of a Snap Store Proxy to use for snaps e.g. http://snap-proxy.example.com

• snapd_refresh | string

  How often snapd handles updates for installed snaps. The default (an empty string) is 4x per day. Set to "max" to check once per month based on the charm deployment date. You may also set a custom string as described in the 'refresh.timer' section here: https://forum.snapcraft.io/t/system-options/87

• track-presence | boolean

  Enable or disable presence tracking in synapse.