__matrix_synapse: use dash instead of underscore in parameter names

type/__matrix_synapse/man.rst

@@ -14,140 +14,140 @@ signleton type.
 
 REQUIRED PARAMETERS
 -------------------
-server_name
+server-name
   Name of your homeserver (e.g. ungleich.ch) used as part of your MXIDs. This
   value cannot be changed without meddling with the database once the server is
   being used.
 
-base_url
+base-url
   Public URL of your homeserver (e.g. http://matrix.ungleich.ch).
 
-database_engine
+database-engine
   'sqlite3' or 'postgresql'
 
-database_name
+database-name
   Path to the database if SQLite3 is used or database name if PostgresSQL is
   used.
 
 OPTIONAL PARAMETERS
 -------------------
-database_host
+database-host
   Database node address, only used with PostgresSQL.
 
-database_user
+database-user
   Database user, only used with PostgresSQL.
 
-database_password
+database-password
   Database password, only used with PostgresSQL.
 
-ldap_uri
+ldap-uri
   Address of your LDAP server.
 
-ldap_base_dn
+ldap-base-dn
   Base DN of your LDAP tree.
 
-ldap_uid_attribute
+ldap-uid-attribute
   LDAP attriute mapping to Synapse's uid field, default to uid.
 
-ldap_mail_attribute
+ldap-mail-attribute
   LDAP attriute mapping to Synapse's mail field, default to mail.
 
-ldap_name_attribute
+ldap-name-attribute
   LDAP attriute mapping to Synapse's name field, default to givenName.
 
-ldap_bind_dn
+ldap-bind-dn
   User used to authenticate against your LDAP server in 'search' mode.
 
-ldap_bind_password
+ldap-bind-password
   Password used to authenticate against your LDAP server in 'search' mode.
 
-ldap_filter
+ldap-filter
   LDAP user filter, defaulting to `(objectClass=posixAccount)`.
 
-turn_uri
+turn-uri
   URI to TURN server, can be provided multiple times if there is more than one
   server.
 
-turn_shared_secret
+turn-shared-secret
   Shared secret used to access the TURN REST API.
 
-turn_user_lifetime
+turn-user-lifetime
   Lifetime of TURN credentials. Defaults to 1h.
 
-max_upload_size
+max-upload-size
   Maximum size for user-uploaded files. Defaults to 10M.
 
-rc_message_per_second
+rc-message-per-second
   Message rate-limiting (per second). Defaults to 0.17.
 
-rc_message_burst
+rc-message-burst
   Message rate-limiting (burst). Defaults to 3.
 
-rc_login_per_second
+rc-login-per-second
   Login rate-limiting (per-second). Defaults to 0.17.
 
-rc_login_burst
+rc-login-burst
   Login rate-limiting (burst). Defaults to 3.
 
-branding_auth_header_logo_url
+branding-auth-header-logo-url
   A logo that is shown in the header during authentication flows.
 
-branding_auth_footer_links
+branding-auth-footer-links
   A list of links to show in the authentication page footer: `[{"text": "Link text", "url": "https://link.target"}, {"text": "Other link", ...}]`
 
-registration_allows_email_pattern
+registration-allows-email-pattern
     Only allow email addresses matching specified filter. Can be specified multiple times. A pattern must look like `.*@vector\.im`.
 
-auto_join_room
+auto-join-room
   Room where newly-registered users are automatically added. Can be specified multiple times.
 
-app_service_config_file
+app-service-config-file
   Path (on remote) of an application service configuration file to load. Can be specified multiple times.
 
-extra_setting
+extra-setting
   Arbitrary string to be added to the configuration file. Can be specified multiple times.
 
 BOOLEAN PARAMETERS
 ------------------
-allow_registration
+allow-registration
   Enables user registration on the homeserver.
 
-enable_ldap_auth
+enable-ldap-auth
   Enables ldap-backed authentication.
 
-ldap_search_mode
+ldap-search-mode
   Enables 'search' mode for LDAP auth backend.
 
-report_stats
+report-stats
   Whether or not to report anonymized homeserver usage statistics.
 
-expose_metrics
+expose-metrics
   Expose metrics endpoint for Prometheus.
 
-disable_federation
+disable-federation
   Disable federation to the broader matrix network.
 
-registration_require_email
+registration-require-email
   Make email a required field on registration.
 
-allow_public_rooms_over_federation
+allow-public-rooms-over-federation
   Allow other homeservers to fetch this server's public room directory.
 
-allow_public_rooms_without_auth
+allow-public-rooms-without-auth
   If set to 'false', requires authentication to access the server's public rooms directory through the client API.
 
-enable_server_notices
+enable-server-notices
   Enable the server notices room.
 
-global_cache_factor
+global-cache-factor
   Controls the global cache factor, which is the default cache factor
   for all caches if a specific factor for that cache is not otherwise
   set. Defaults to 0.5.
 
-event_cache_size
+event-cache-size
   Number of events to cache in memory. Defaults to 10K.
 
-allow_guest_access
+allow-guest-access
   Allows users to register as guests without a password/email/etc, and
   participate in rooms hosted on this server which have been made accessible to
   anonymous users.
@@ -157,14 +157,14 @@ EXAMPLES
 
 .. code-block:: sh
 
-    __matrix_synapse --server_name ungleich.ch \
+    __matrix_synapse --server-name ungleich.ch \
-      --base_url https://matrix.ungleich.ch \
+      --base-url https://matrix.ungleich.ch \
-      --database_engine sqlite3 \
+      --database-engine sqlite3 \
-      --database_name /var/lib/matrix-syanpse/homeserver.db
+      --database-name /var/lib/matrix-syanpse/homeserver.db
 
 SEE ALSO
 --------
-- `cdist-type__matrix_riot(7) <cdist-type__matrix_riot.html>`_
+- `cdist-type__matrix_element(7) <cdist-type__matrix_element.html>`_
 
 
 AUTHORS

type/__matrix_synapse/manifest

@@ -66,9 +66,9 @@ case "$os" in
 esac
 
 # Required parameters:
-SERVER_NAME=$(cat "$__object/parameter/server_name")
+SERVER_NAME=$(cat "$__object/parameter/server-name")
 export SERVER_NAME
-BASE_URL=$(cat "$__object/parameter/base_url")
+BASE_URL=$(cat "$__object/parameter/base-url")
 export BASE_URL
 
 export DATA_DIR=$synapse_data_dir
@@ -77,158 +77,158 @@ export PIDFILE='/var/run/matrix/homeserver.pid'
 export LOG_CONFIG_PATH="$synapse_conf_dir/log.yaml"
 export SIGNING_KEY_PATH="$synapse_conf_dir/signin.key"
 
-DATABASE_ENGINE=$(cat "$__object/parameter/database_engine")
+DATABASE_ENGINE=$(cat "$__object/parameter/database-engine")
 export DATABASE_ENGINE
-DATABASE_NAME=$(cat "$__object/parameter/database_name")
+DATABASE_NAME=$(cat "$__object/parameter/database-name")
 export DATABASE_NAME
 
 # Optional parameters:
-DATABASE_HOST=$(cat "$__object/parameter/database_host")
+DATABASE_HOST=$(cat "$__object/parameter/database-host")
 export DATABASE_HOST
-DATABASE_USER=$(cat "$__object/parameter/database_user")
+DATABASE_USER=$(cat "$__object/parameter/database-user")
 export DATABASE_USER
-DATABASE_PASSWORD=$(cat "$__object/parameter/database_password")
+DATABASE_PASSWORD=$(cat "$__object/parameter/database-password")
 export DATABASE_PASSWORD
 
-GLOBAL_CACHE_FACTOR=$(cat "$__object/parameter/global_cache_factor")
+GLOBAL_CACHE_FACTOR=$(cat "$__object/parameter/global-cache-factor")
 export GLOBAL_CACHE_FACTOR
-EVENT_CACHE_SIZE=$(cat "$__object/parameter/event_cache_size")
+EVENT_CACHE_SIZE=$(cat "$__object/parameter/event-cache-size")
 export EVENT_CACHE_SIZE
 
-LDAP_FILTER=$(cat "$__object/parameter/ldap_filter")
+LDAP_FILTER=$(cat "$__object/parameter/ldap-filter")
 export LDAP_FILTER
-LDAP_UID_ATTRIBUTE=$(cat "$__object/parameter/ldap_uid_attribute")
+LDAP_UID_ATTRIBUTE=$(cat "$__object/parameter/ldap-uid-attribute")
 export LDAP_UID_ATTRIBUTE
-LDAP_MAIL_ATTRIBUTE=$(cat "$__object/parameter/ldap_mail_attribute")
+LDAP_MAIL_ATTRIBUTE=$(cat "$__object/parameter/ldap-mail-attribute")
 export LDAP_MAIL_ATTRIBUTE
-LDAP_NAME_ATTRIBUTE=$(cat "$__object/parameter/ldap_name_attribute")
+LDAP_NAME_ATTRIBUTE=$(cat "$__object/parameter/ldap-name-attribute")
 export LDAP_NAME_ATTRIBUTE
-LDAP_URI=$(cat "$__object/parameter/ldap_uri")
+LDAP_URI=$(cat "$__object/parameter/ldap-uri")
 export LDAP_URI
-LDAP_BASE_DN=$(cat "$__object/parameter/ldap_base_dn")
+LDAP_BASE_DN=$(cat "$__object/parameter/ldap-base-dn")
 export LDAP_BASE_DN
-LDAP_BIND_DN=$(cat "$__object/parameter/ldap_bind_dn")
+LDAP_BIND_DN=$(cat "$__object/parameter/ldap-bind-dn")
 export LDAP_BIND_DN
-LDAP_BIND_PASSWORD=$(cat "$__object/parameter/ldap_bind_password")
+LDAP_BIND_PASSWORD=$(cat "$__object/parameter/ldap-bind-password")
 export LDAP_BIND_PASSWORD
 
-TURN_USER_LIFETIME=$(cat "$__object/parameter/turn_user_lifetime")
+TURN_USER_LIFETIME=$(cat "$__object/parameter/turn-user-lifetime")
 export TURN_USER_LIFETIME
-if [ -f "$__object/parameter/turn_shared_secret" ]; then
+if [ -f "$__object/parameter/turn-shared-secret" ]; then
-    TURN_SHARED_SECRET=$(cat "$__object/parameter/turn_shared_secret")
+    TURN_SHARED_SECRET=$(cat "$__object/parameter/turn-shared-secret")
     export TURN_SHARED_SECRET
 fi
-if [ -f "$__object/parameter/turn_uri" ]; then
+if [ -f "$__object/parameter/turn-uri" ]; then
-    uris=$(tr "\n" "," < "$__object/parameter/turn_uri" | sed 's/,$//')
+    uris=$(tr "\n" "," < "$__object/parameter/turn-uri" | sed 's/,$//')
     export TURN_URIS="[$uris]"
 fi
 
-if [ -f "$__object/parameter/registration_allows_email_pattern" ]; then
+if [ -f "$__object/parameter/registration-allows-email-pattern" ]; then
-    RESGISTRATION_ALLOWS_EMAIL_PATTERN=$(cat "$__object/parameter/registration_allows_email_pattern")
+    RESGISTRATION_ALLOWS_EMAIL_PATTERN=$(cat "$__object/parameter/registration-allows-email-pattern")
     export RESGISTRATION_ALLOWS_EMAIL_PATTERN
 fi
 
-if [ -f "$__object/parameter/auto_join_room" ]; then
+if [ -f "$__object/parameter/auto-join-room" ]; then
-    AUTO_JOIN_ROOMS="$(cat "$__object/parameter/auto_join_room")"
+    AUTO_JOIN_ROOMS="$(cat "$__object/parameter/auto-join-room")"
     export AUTO_JOIN_ROOMS
 fi
 
-if [ -f "$__object/parameter/app_service_config_file" ]; then
+if [ -f "$__object/parameter/app-service-config-file" ]; then
-    APP_SERVICE_CONFIG_FILES=$(cat "$__object/parameter/app_service_config_file")
+    APP_SERVICE_CONFIG_FILES=$(cat "$__object/parameter/app-service-config-file")
     export APP_SERVICE_CONFIG_FILES
 fi
 
-MAX_UPLOAD_SIZE=$(cat "$__object/parameter/max_upload_size")
+MAX_UPLOAD_SIZE=$(cat "$__object/parameter/max-upload-size")
 export MAX_UPLOAD_SIZE
-RIOT_BASE_URL=$(cat "$__object/parameter/riot_base_url")
+RIOT_BASE_URL=$(cat "$__object/parameter/riot-base-url")
 export RIOT_BASE_URL
 
-SMTP_HOST=$(cat "$__object/parameter/smtp_host")
+SMTP_HOST=$(cat "$__object/parameter/smtp-host")
 export SMTP_HOST
-SMTP_PORT=$(cat "$__object/parameter/smtp_port")
+SMTP_PORT=$(cat "$__object/parameter/smtp-port")
 export SMTP_PORT
-SMTP_USER=$(cat "$__object/parameter/smtp_user")
+SMTP_USER=$(cat "$__object/parameter/smtp-user")
 export SMTP_USER
-SMTP_PASS=$(cat "$__object/parameter/smtp_pass")
+SMTP_PASS=$(cat "$__object/parameter/smtp-pass")
 export SMTP_PASS
 
-RC_MESSAGE_PER_SECOND=$(cat "$__object/parameter/rc_message_per_second")
+RC_MESSAGE_PER_SECOND=$(cat "$__object/parameter/rc-message-per-second")
 export RC_MESSAGE_PER_SECOND
 RC_MESSAGE_BURST=$(cat "$__object/parameter/rc_message_burst")
 export RC_MESSAGE_BURST
-RC_LOGIN_PER_SECOND=$(cat "$__object/parameter/rc_login_per_second")
+RC_LOGIN_PER_SECOND=$(cat "$__object/parameter/rc-login-per-second")
 export RC_LOGIN_PER_SECOND
-RC_LOGIN_BURST=$(cat "$__object/parameter/rc_login_burst")
+RC_LOGIN_BURST=$(cat "$__object/parameter/rc-login-burst")
 export RC_LOGIN_BURST
 
-if [ -f "$__object/parameter/extra_setting" ]; then
+if [ -f "$__object/parameter/extra-setting" ]; then
-    EXTRA_SETTINGS=$(cat "$__object/parameter/extra_setting")
+    EXTRA_SETTINGS=$(cat "$__object/parameter/extra-setting")
     export EXTRA_SETTINGS
 fi
 
 # Boolean parameters:
-if [ -f "$__object/parameter/report_stats" ]; then
+if [ -f "$__object/parameter/report-stats" ]; then
     export REPORT_STATS='true'
 else
     export REPORT_STATS='false'
 fi
-if [ -f "$__object/parameter/allow_registration" ]; then
+if [ -f "$__object/parameter/allow-registration" ]; then
     export ALLOW_REGISTRATION='true'
 else
     export ALLOW_REGISTRATION='false'
 fi
-if [ -f "$__object/parameter/enable_ldap_auth" ]; then
+if [ -f "$__object/parameter/enable-ldap-auth" ]; then
     export ENABLE_LDAP_AUTH='true'
 else
     export ENABLE_LDAP_AUTH='false'
 fi
-if [ -f "$__object/parameter/ldap_search_mode" ]; then
+if [ -f "$__object/parameter/ldap-search-mode" ]; then
     export LDAP_SEARCH_MODE=1
 fi
-if [ -f "$__object/parameter/expose_metrics" ]; then
+if [ -f "$__object/parameter/expose-metrics" ]; then
     export EXPOSE_METRICS='true'
 else
     export EXPOSE_METRICS='false'
 fi
-if [ -f "$__object/parameter/enable_notifications" ]; then
+if [ -f "$__object/parameter/enable-notifications" ]; then
     export ENABLE_NOTIFICATIONS='true'
 else
     export ENABLE_NOTIFICATIONS='false'
 fi
-if [ -f "$__object/parameter/enable_notifications_by_default" ]; then
+if [ -f "$__object/parameter/enable_notifications-by-default" ]; then
     export ENABLE_NOTIFICATIONS_BY_DEFAULT='true'
 else
     export ENABLE_NOTIFICATIONS_BY_DEFAULT='false'
 fi
-if [ -f "$__object/parameter/smtp_requires_tls" ]; then
+if [ -f "$__object/parameter/smtp-requires-tls" ]; then
     export SMTP_TLS='true'
 else
     export SMTP_TLS='false'
 fi
-if [ -f "$__object/parameter/disable_federation" ]; then
+if [ -f "$__object/parameter/disable-federation" ]; then
     export DISABLE_FEDERATION='true'
 else
     export DISABLE_FEDERATION='false'
 fi
-if [ -f "$__object/parameter/allow_guest_access" ]; then
+if [ -f "$__object/parameter/allow-guest-access" ]; then
     export ALLOW_GUEST_ACCESS='true'
 else
     export ALLOW_GUEST_ACCESS='false'
 fi
-if [ -f "$__object/parameter/registration_requires_email" ]; then
+if [ -f "$__object/parameter/registration-requires-email" ]; then
     export REGISTRATION_REQUIRES_EMAIL=1
 fi
-if [ -f "$__object/parameter/allow_public_rooms_over_federation" ]; then
+if [ -f "$__object/parameter/allow-public-rooms-over-federation" ]; then
     export ALLOW_PUBLIC_ROOMS_OVER_FEDERATION='true'
 else
     export ALLOW_PUBLIC_ROOMS_OVER_FEDERATION='false'
 fi
-if [ -f "$__object/parameter/allow_public_rooms_without_auth" ]; then
+if [ -f "$__object/parameter/allow-public-rooms-without-auth" ]; then
     export ALLOW_PUBLIC_ROOMS_WITHOUT_AUTH='true'
 else
     export ALLOW_PUBLIC_ROOMS_WITHOUT_AUTH='false'
 fi
-if [ -f "$__object/parameter/enable_server_notices" ]; then
+if [ -f "$__object/parameter/enable-server-notices" ]; then
     export ENABLE_SERVER_NOTICES=1
 fi
 

type/__matrix_synapse/parameter/boolean

@@ -1,14 +1,14 @@
-allow_registration
+allow-registration
-enable_ldap_auth
+enable-ldap-auth
-ldap_search_mode
+ldap-search-mode
-report_stats
+report-stats
-expose_metrics
+expose-metrics
-enable_notifications
+enable-notifications
-enable_notifications_by_default
+enable-notifications-by-default
-smtp_requires_tls
+smtp-requires-tls
-disable_federation
+disable-federation
-registration_requires_email
+registration-requires-email
-allow_public_rooms_over_federation
+allow-public-rooms-over-federation
-enable_server_notices
+enable-server-notices
-allow_guest_access
+allow-guest-access
-allow_public_rooms_without_auth
+allow-public-rooms-without-auth

type/__matrix_synapse/parameter/optional

@@ -1,25 +1,25 @@
-database_host
+database-host
-database_user
+database-user
-database_password
+database-password
-ldap_uri
+ldap-uri
-ldap_base_dn
+ldap-base-dn
-ldap_uid_attribute
+ldap-uid-attribute
-ldap_mail_attribute
+ldap-mail-attribute
-ldap_name_attribute
+ldap-name-attribute
-ldap_bind_dn
+ldap-bind-dn
-ldap_bind_password
+ldap-bind-password
-ldap_filter
+ldap-filter
-turn_shared_secret
+turn-shared-secret
-turn_user_lifetime
+turn-user-lifetime
-max_upload_size
+max-upload-size
-smtp_host
+smtp-host
-smtp_port
+smtp-port
-smtp_user
+smtp-user
-smtp_pass
+smtp-pass
-riot_base_url
+riot-base-url
-rc_message_per_second
+rc-message-per-second
-rc_message_burst
+rc-message-burst
-rc_login_per_second
+rc-login-per-second
-rc_login_burst
+rc-login-burst
-global_cache_factor
+global-cache-factor
-event_cache_size
+event-cache-size

type/__matrix_synapse/parameter/optional_multiple

@@ -1,5 +1,5 @@
-turn_uri
+turn-uri
-registration_allows_email_pattern
+registration-allows-email-pattern
-auto_join_room
+auto-join-room
-app_service_config_file
+app-service-config-file
-extra_setting
+extra-setting

type/__matrix_synapse/parameter/required

@@ -1,4 +1,4 @@
-server_name
+server-name
-base_url
+base-url
-database_engine
+database-engine
-database_name
+database-name