mautrix_signal_ynh/config_panel.toml

version = "1.0"

[appservice]
name = "Homeserver Application Service"
services = ["__APP__"]

    [appservice.config]
    name = "Appservice Settings"

        [appservice.config.ephemeral_events]
        ask = "Receive Ephemeral Events via Appservice transactions?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Requires MSC2409 support (i.e. Synapse 1.22+). You should disable bridge -> sync_with_custom_puppets when this is enabled"
        bind = ":__FINALPATH__/config.yaml"

        [appservice.config.print_level]
        ask = "Root logging print level"
        type = "select"
        choices = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL", "NOTSET"]
        help = "NOTSET means that all messages will be logged: https://docs.python.org/3.6/library/logging.config.html#configuration-file-format"
        bind = "root>level:__FINALPATH__/config.yaml"

    [appservice.bot]
    name = "Robot Settings"

        [appservice.bot.appserviceid]
        ask = "Unique ID of Appservice"
        type = "string"
        bind = "appservice>id:__FINALPATH__/config.yaml"

        [appservice.bot.botname]
        ask = "Username of the Appservice Bot"
        type = "string"
        help = "Sets bot username. Please keep in mind that the bot admin room for previous bot username will stop working so you may need to create a new one using the new username"
        bind = "appservice>bot_username:__FINALPATH__/config.yaml"

        [appservice.bot.displayname]
        ask = "Display Name for Bot"
        type = "string"
        help = "Set to 'remove' to remove display name, leave empty to leave display name as-is"
        bind = "appservice>bot_displayname:__FINALPATH__/config.yaml"

        [appservice.bot.avatar]
        ask = "Avatar for Bot"
        type = "string"
        help = "Set to 'remove' to remove avatar, leave empty to leave avatar as-is"
        bind = "appservice>bot_avatar:__FINALPATH__/config.yaml"

    [appservice.metrics]
    name = "Prometheus Metrics"

        [appservice.metrics.enable_metrics]
        ask = "Enable Prometheus Metrics?"
        type = "boolean"
        yes = "true"
        no = "false"
        bind = "metrics>enabled:__FINALPATH__/config.yaml"

        [appservice.metrics.listen_port]
        ask = "Port for the Metrics listener?"
        type = "string"
        help = "Default 8000."
        bind = ":__FINALPATH__/config.yaml"

[signald]
name = "Signal Daemon Service"
services = ["__APP__"]

    [signald.config]
    name = "Signald Settings"

        [signald.config.registration_enabled]
        ask = "Can Bridge Users register as a primary device?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "If yes, you still need a phone number to register signald as you primary device. If not, you need a phone with Signal App."
        bind = ":__FINALPATH__/config.yaml"

        [signald.config.enable_disappearing_messages_in_groups]
        ask = "Enable disappearing messages in groups?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "If the bridge has a single user, this can be turned on safely. If enabled, then the expiration time of the messages will be determined by the first users to read the message, rather than individually."
        bind = ":__FINALPATH__/config.yaml"

[bridge]
name = "Bridge"
services = ["__APP__"]

    [bridge.config]
    name = "Puppet Settings"

        [bridge.config.username_template]
        ask = "Localpart template of MXIDs for Signal users."
        type = "string"
        help = "{userid} is replaced with an identifier for the Signal user."
        bind = ":__FINALPATH__/config.yaml"

        [bridge.config.contact_list_names]
        ask = "Should contact list displaynames be used?"
        type = "select"
        choices = ["disallow", "allow", "prefer"]
        help = "Multi-user instances are recommended to disallow contact list names, as otherwise there can be conflicts between names from different users' contact lists."
        bind = ":__FINALPATH__/config.yaml"

        [bridge.config.enable_relaybot]
        ask = "Should Relay mode be allowed?"
        type = "boolean"
        yes = "true"
		no = "false"
        help = "If allowed, `!sg set-relay` can be used to turn any authenticated user into a RelayBot for that chat."
        bind = ":__FINALPATH__/config.yaml"

    [bridge.portal_rooms]
    name = "Portal Rooms & Encryption Settings"

        [bridge.portal_rooms.federate_rooms]
        ask = "Should Portal Rooms have federation enabled?"
        type = "boolean"
        yes = "true"
		no = "false"
        help = "If false, Portal Rooms created by the Bridge will never be federated."
        bind = ":__FINALPATH__/config.yaml"

        [bridge.portal_rooms.encryption]
        ask = "Allow End-to-Bridge (e2b) Encryption?"
        type = "boolean"
        yes = "true"
		no = "false"
        help = "For the Bridge to work in group chat Rooms with End-to-End Encryption (e2ee) enabled."
        bind = "encryption>allow:__FINALPATH__/config.yaml"
        
        [bridge.portal_rooms.encryption_default]
        ask = "Force-enable Encryption in all Portal Rooms the Bridge creates?"
        type = "boolean"
        yes = "true"
		no = "false"
        help = "This will cause the Bridge Bot to be in private chats for the Encryption to work properly."
        bind = "encryption>default:__FINALPATH__/config.yaml"

[usermanagement]
name = "Bridge Permissions"
services = ["__APP__"]

    [usermanagement.config]
    name = "User, Admin, Relay Management"

        [usermanagement.config.helptext]
        ask = '''
        Allowed values:
        - * : All Matrix users
        - domain.tld : All users on a given homeserver
        - mxid (@user:matrix.org) : Specific Matrix user
        '''
        type = "markdown"

        [usermanagement.config.listuser]
        ask = "Users"
        type = "tags"
        visible = "role == 'user'"

        [usermanagement.config.listadmin]
        ask = "Admins"
        type = "tags"
        visible = "role == 'admin'"

        [usermanagement.config.listrelay]
        ask = "Relay users"
        type = "tags"
        visible = "role == 'relay'"

        [usermanagement.config.role]
        ask = "Role"
        type = "select"
        choices = ["user", "admin", "relay"]