Components

Available components:

• Info
• Menu
• Packages
• Daemon
• Firewall
• Webserver
• Frontpage
• Domain Name
• Let’s Encrypt
• StaticFiles
• Backups
• Coturn

Base Classes

class plinth.app.Component(component_id)

Interface for an app component.

app_id is a string which is set to the value of the application’s app_id to which this component belongs. It is set when the component is added to an app. When the component is removed from an app, it set to None.

__init__(component_id)

Initialize the component.

property app

Return the app this component is part of.

Raises KeyError if this component is not part of any app.

static diagnose()

Run diagnostics and return results.

Return value must be a list of results. Each result is a two-tuple with first value as user visible description of the test followed by the result. The test result is a string enumeration from ‘failed’, ‘passed’ and ‘error’.

Also see has_diagnostics().

disable()

Run operations to disable the component.

enable()

Run operations to enable the component.

has_diagnostics()

Return whether at least one diagnostic test is implemented.

If this method return True, the App.has_diagnostics(). also returns True.

If a subclass of Component overrides the diagnose() method, it is assumed that it is for implementing diagnostic tests and this method returns True for such a component. Override this method if this default behavior does not fit the needs.

setup(old_version)

Run operations to install and configure the component.

class plinth.app.LeaderComponent(component_id)

Interface for an app component that decides the state of the app.

These components determine if the app is enabled or not.

is_enabled()

Return if the component is enabled.

class plinth.app.FollowerComponent(component_id, is_enabled=False)

Interface for an app component that follows other components.

These components of the app don’t determine if the app is enabled or not.

__init__(component_id, is_enabled=False)

Initialize the component.

disable()

Run operations to disable the component.

enable()

Run operations to enable the component.

is_enabled()

Return whether the component is enabled.

set_enabled(enabled)

Update the internal enabled state of the component.