Skip to content

config_local.yml reference

Wojciech Frącz edited this page Mar 26, 2020 · 1 revision
supla:

    # Version is set by the release script.
    version:              '?.?.?'

    # Version with git hash, set by the release script.
    version_full:         null

    # The address of the supla-autodiscover service.
    autodiscover_url:     'https://autodiscover.supla.org'

    # If false, the registration of new users will be disabled.
    accounts_registration_enabled: true

    # If maintenance mode is true, no modifying actions will be allowed.
    maintenance_mode:     false

    # Information set by the build system. Do not change it.
    webpack_hashes:

        # Prototype
        script_name:          ~
    clients_registration:
        registration_active_time:

            # For how many seconds the smartphones registration should be enabled for new accounts.
            initial:              604800

            # For how many seconds the smartphones registration should be enabled after clicking "enable".
            manual:               86400
    io_devices_registration:
        registration_active_time:

            # For how many seconds the devices registration should be enabled for new accounts.
            initial:              604800

            # For how many seconds the smartphones registration should be enabled after clicking "enable".
            manual:               86400
    brute_force_auth_prevention:

        # Whether to enable the prevention of guessing the accounts password.
        enabled:              false

        # How many failed attempts to login should result in a ban.
        max_failed_attempts:  3

        # How long the ban should be (in seconds).
        block_time_seconds:   1200
    oauth:

        # Lifetime of the OAuth tokens per type, in format [access_token_lifetime, refresh_token_lifetime], in seconds
        tokens_lifetime:      # Example: [3600, 86400]
            webapp:               []
            client_app:           []
            admin:                []
            user:                 []
            broker:               []
    maintenance:

        # How many hours should be allowed to activate an account.
        delete_non_confirmed_users_older_than_hours: 24

        # How many days should the audit entries be kept in the database.
        delete_audit_entries_older_than_days: 60

        # Custom rules for keeping the audit entires.
        delete_audit_entries_older_than_days_custom: # Example: DIRECT_LINK_EXECUTION: 2

            # Prototype
            event_name:           ~
    api_rate_limit:

        # Should the API requests be counted?
        enabled:              true

        # Should the API rate limit excess result in blocking requests? If false, the excesses will be logged only.
        blocking:             false

        # Default limit of API requests for users. In format: requests/seconds
        user_default_limit:   1000/3600 # Example: 100/60

        # Global limit of API requests. If exceeded, all requests will be considered as exceeding the limit until the reset. In format: requests/seconds
        global_limit:         1000/60 # Example: 100/60