pihole_ynh/config_panel.toml.example

version = "1.0"
name = "PiHole configuration panel"

[main]
name = "PiHole configuration"

    [main.overwrite_files]
    name = "Overwriting config files"

        [main.overwrite_files.overwrite_setupvars]
        ask = "Overwrite the config file setupVars.conf?"
        type = "boolean"
        default = true
        help = "If the file is overwritten, a backup will be created."

        [main.overwrite_files.overwrite_ftl]
        ask = "Overwrite the config file pihole-FTL.conf?"
        type = "boolean"
        default = true
        help = "If the file is overwritten, a backup will be created."

        [main.overwrite_files.overwrite_nginx]
        ask = "Overwrite the nginx config file?"
        type = "boolean"
        default = true
        help = "If the file is overwritten, a backup will be created."

        [main.overwrite_files.overwrite_phpfpm]
        ask = "Overwrite the php-fpm config file?"
        type = "boolean"
        default = true
        help = "If the file is overwritten, a backup will be created."


    [main.global_config]
    name = "Global configuration"

        [main.global_config.email_type]
        ask = "Send HTML email to admin?"
        type = "boolean"
        default = true
        help = "Allow app scripts to send HTML mails instead of plain text."


    [main.php_fpm_config]
    name = "PHP-FPM configuration"

        [main.php_fpm_config.footprint]
        ask = "Memory footprint of the service?"
        choices = ["low", "medium", "high", "specific"]
        default = "low"
        help = "low <= 20Mb per pool. medium between 20Mb and 40Mb per pool. high > 40Mb per pool.<br>Use specific to set a value with the following option."

        [main.php_fpm_config.free_footprint]
        ask = "Memory footprint of the service?"
        type = "number"
        default = "0"
        help = "Free field to specify exactly the footprint in Mb if you don't want to use one of the three previous values."

        [main.php_fpm_config.usage]
        ask = "Expected usage of the service?"
        choices = ["low", "medium", "high"]
        default = "low"
        help = "low: Personal usage, behind the sso. No RAM footprint when not used, but the impact on the processor can be high if many users are using the service.<br>medium: Low usage, few people or/and publicly accessible. Low RAM footprint, medium processor footprint when used.<br>high: High usage, frequently visited website. High RAM footprint, but lower on processor usage and quickly responding."

        [main.php_fpm_config.force_max_children]
        ask = "Force the value of pm.max_children?"
        type = "number"
        default = "0"
        help = "Do not change this value unless you're sure about what you're doing !<br>pm.max_children is automatically defined by this formula: $max_ram / 2 / $footprint<br>You can force that value, and ignore the formula by changing the value here.<br>To reset to the default value, set to 0."