Toggle Light / Dark / Auto color theme
Toggle table of contents sidebar
Source code for betty.extension.nginx.serve
"""
Integrate the nginx extension with Betty's Serve API.
"""
import logging
from contextlib import AsyncExitStack
from pathlib import Path
from typing import final
import docker
from aiofiles.tempfile import TemporaryDirectory
from docker.errors import DockerException
from typing_extensions import override
from betty.extension.nginx import Nginx
from betty.extension.nginx.config import NginxConfiguration
from betty.extension.nginx.artifact import (
generate_dockerfile_file,
generate_configuration_file,
)
from betty.extension.nginx.docker import Container
from betty.project import Project
from betty.serve import NoPublicUrlBecauseServerNotStartedError, Server
[docs]
@final
class DockerizedNginxServer(Server):
"""
An nginx server that runs within a Docker container.
"""
[docs]
def __init__(self, project: Project) -> None:
super().__init__(project.app.localizer)
self._project = project
self._exit_stack = AsyncExitStack()
self._container: Container | None = None
[docs]
@override
async def start(self) -> None:
await super().start()
logging.getLogger(__name__).info("Starting a Dockerized nginx web server...")
output_directory_path_str: str = await self._exit_stack.enter_async_context(
TemporaryDirectory() # type: ignore[arg-type]
)
isolated_project: Project = await self._exit_stack.enter_async_context(
Project.new_temporary(self._project.app, ancestry=self._project.ancestry)
)
isolated_project.configuration.configuration_file_path = (
self._project.configuration.configuration_file_path
)
isolated_project.configuration.update(self._project.configuration)
isolated_project.configuration.debug = True
# Work around https://github.com/bartfeenstra/betty/issues/1056.
nginx_configuration = isolated_project.configuration.extensions[
Nginx
].extension_configuration
assert isinstance(nginx_configuration, NginxConfiguration)
nginx_configuration.https = False
await self._exit_stack.enter_async_context(isolated_project)
nginx_configuration_file_path = Path(output_directory_path_str) / "nginx.conf"
docker_directory_path = Path(output_directory_path_str)
dockerfile_file_path = docker_directory_path / "Dockerfile"
await generate_configuration_file(
isolated_project,
destination_file_path=nginx_configuration_file_path,
https=False,
www_directory_path="/var/www/betty",
)
await generate_dockerfile_file(
isolated_project,
destination_file_path=dockerfile_file_path,
)
self._container = Container(
isolated_project.configuration.www_directory_path,
docker_directory_path,
nginx_configuration_file_path,
)
await self._exit_stack.enter_async_context(self._container)
await self.assert_available()
[docs]
@override
async def stop(self) -> None:
await self._exit_stack.aclose()
@override
@property
def public_url(self) -> str:
if self._container is not None:
return "http://%s" % self._container.ip
raise NoPublicUrlBecauseServerNotStartedError()
[docs]
@classmethod
def is_available(cls) -> bool:
"""
Check if Docker is available.
"""
try:
docker.from_env()
return True
except DockerException as e:
logging.getLogger(__name__).warning(e)
return False