Attention

This is the documentation for HARP Proxy, actually published as an early preview. Both the software and documentation are a work in progress, and although we already use it on various production servers, they may contain inaccuracies, typographical errors, huge mistakes and empty pages. We work hard to eradicate all mistakes and implement stuff, but it is a long and tedious process. We appreciate your patience and understanding. Of course, any help will be greatly appreciated.

harp_apps.dashboard.settings

class DashboardAuthBasicSetting[source]

Bases: BaseSetting

DashboardAuthBasicSetting(type: str = ‘basic’, algorithm: str = ‘pbkdf2_sha256’, users: Union[harp.config.settings.from_file.FromFileSetting, dict[str, str], NoneType] = None)

__init__(type='basic', algorithm='pbkdf2_sha256', users=None)
Parameters:
Return type:

None

check(username, password)[source]
algorithm: str = 'pbkdf2_sha256'
property algorithm_impl
type: str = 'basic'
users: FromFileSetting | dict[str, str] | None = None
class DashboardAuthSetting[source]

Bases: BaseSetting

DashboardAuthSetting(**kwargs)

__init__(type=None)
Parameters:

type (Literal['basic'] | None)

Return type:

None

static __new__(cls, **kwargs)[source]
check(username, password)[source]
type: Literal['basic'] | None = None
class DashboardDevserverSettings[source]

Bases: DisableableBaseSettings

DashboardDevserverSettings(enabled: Optional[bool] = True, port: Union[int, str, NoneType] = None)

__init__(enabled=True, port=None)
Parameters:
Return type:

None

port: int | str | None = None
class DashboardSettings[source]

Bases: BaseSetting

Root settings for the dashboard.

__init__(port=4080, auth=None, devserver=None)
Parameters:
Return type:

None

auth: DashboardAuthSetting | None = None
devserver: DashboardDevserverSettings | None = None
port: int | str = 4080