dynamic_preferences_registry.py

from django.forms import widgets

from dynamic_preferences import types
from dynamic_preferences.registries import global_preferences_registry

raven = types.Section('raven')
instance = types.Section('instance')


@global_preferences_registry.register
class InstanceName(types.StringPreference):
    show_in_api = True
    section = instance
    name = 'name'
    default = ''
    help_text = 'Instance public name'
    verbose_name = 'The public name of your instance'


@global_preferences_registry.register
class InstanceShortDescription(types.StringPreference):
    show_in_api = True
    section = instance
    name = 'short_description'
    default = ''
    verbose_name = 'Instance succinct description'


@global_preferences_registry.register
class InstanceLongDescription(types.StringPreference):
    show_in_api = True
    section = instance
    name = 'long_description'
    default = ''
    help_text = 'Instance long description (markdown allowed)'
    field_kwargs = {
        'widget': widgets.Textarea
    }

@global_preferences_registry.register
class RavenDSN(types.StringPreference):
    show_in_api = True
    section = raven
    name = 'front_dsn'
    default = 'https://9e0562d46b09442bb8f6844e50cbca2b@sentry.eliotberriot.com/4'
    verbose_name = (
        'A raven DSN key used to report front-ent errors to '
        'a sentry instance'
    )
    help_text = (
        'Keeping the default one will report errors to funkwhale developers'
    )


SENTRY_HELP_TEXT = (
    'Error reporting is disabled by default but you can enable it if'
    ' you want to help us improve funkwhale'
)


@global_preferences_registry.register
class RavenEnabled(types.BooleanPreference):
    show_in_api = True
    section = raven
    name = 'front_enabled'
    default = False
    verbose_name = (
        'Wether error reporting to a Sentry instance using raven is enabled'
        ' for front-end errors'
    )


@global_preferences_registry.register
class InstanceNodeinfoEnabled(types.BooleanPreference):
    show_in_api = False
    section = instance
    name = 'nodeinfo_enabled'
    default = True
    verbose_name = 'Enable nodeinfo endpoint'
    help_text = (
        'This endpoint is needed for your about page to work.'
        'It\'s also helpful for the various monitoring '
        'tools that map and analyzize the fediverse, '
        'but you can disable it completely if needed.'
    )


@global_preferences_registry.register
class InstanceNodeinfoStatsEnabled(types.BooleanPreference):
    show_in_api = False
    section = instance
    name = 'nodeinfo_stats_enabled'
    default = True
    verbose_name = 'Enable usage and library stats in nodeinfo endpoint'
    help_text = (
        'Disable this f you don\'t want to share usage and library statistics'
        'in the nodeinfo endpoint but don\'t want to disable it completely.'
    )