Dashboard Settings¶
Examples¶
Here is an example containing all default values for the dashboard
application settings.
dashboard:
auth: null
devserver:
enabled: true
port: null
enable_ui: true
port: 4080
public_url: null
Reference¶
Implementation (python): DashboardSettings
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
Port |
Port on which the dashboard application will be served. |
|||
port |
integer |
|||
Default |
4080
|
|||
Auth |
Authentication settings for the dashboard. |
|||
auth |
object |
|||
Devserver |
Development server settings, only useful for internal frontend development. |
|||
devserver |
object |
|||
Enable Ui |
DEPRECATED – Whether to enable the dashboard UI. |
|||
enable_ui |
boolean |
|||
Default |
true
|
|||
Public Url |
Public URL of the dashboard application, used to generate absolute links, for example in notifications. |
|||
public_url |
object |
.auth¶
Implementation (python): BasicAuthSettings
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
Type |
Authentication type. Only «basic» is supported for now. |
|||
type |
string |
|||
Algorithm |
Hashing algorithm used for passwords. |
|||
algorithm |
string |
|||
Default |
pbkdf2_sha256
|
|||
Users |
Users list. |
|||
users |
object |
|||
User |
||||
users/* |
object |
|||
Users Password |
||||
users/*/password |
string |
Required |
.devserver¶
Implementation (python): DevServerSettings
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
Enabled |
Enable or disable the development server. |
|||
enabled |
boolean |
|||
Default |
true
|
|||
Port |
Port on which the development server will be served (internal). The proxy will forward dashboard requests to this port, if enabled. |
|||
port |
object |