betty.extension.nginx package

Submodules

Module contents

Integrate Betty with nginx.

final class betty.extension.nginx.Nginx[source]

Bases: ConfigurableExtension[NginxConfiguration]

Integrate Betty with nginx (and Docker).

classmethod assets_directory_path() Path | None[source]

Return the path on disk where the extension’s assets are located.

This may be anywhere in your Python package.

classmethod default_configuration() NginxConfiguration[source]

Get this extension’s default configuration.

property https: bool

Whether the nginx server should use HTTPS.

classmethod plugin_description() Localizable[source]

Get the human-readable long plugin description.

classmethod plugin_id() str[source]

Get the plugin ID.

IDs are unique per plugin type:

  • A plugin repository MUST at most have a single plugin for any ID.

  • Different plugin repositories MAY each have a plugin with the same ID.

classmethod plugin_label() Localizable[source]

Get the human-readable short plugin label.

register_event_handlers(registry: EventHandlerRegistry) None[source]

Register event handlers with the project.

property www_directory_path: str

The nginx server’s public web root directory path.