Обслуживание статических файлов

Эти настройки используются для управления обслуживанием статических файлов сервером.

Bases: BaseModel

Static files serving settings.

Files are served at /static endpoint.

Examples

.. code-block:: yaml :caption: config.yml

server:
    static_files:
        enabled: True
        directory: /app/syncmaster/server/static

Source code in syncmaster/server/settings/server/static_files.py

class StaticFilesSettings(BaseModel):
    """Static files serving settings.

    Files are served at ``/static`` endpoint.

    Examples
    --------

    .. code-block:: yaml
        :caption: config.yml

        server:
            static_files:
                enabled: True
                directory: /app/syncmaster/server/static
    """

    enabled: bool = Field(default=True, description="Set to ``True`` to enable static file serving")
    directory: Path = Field(
        default=Path("docs/_static"),
        description="Directory containing static files",
    )

    @field_validator("directory")
    @classmethod
    def _validate_directory(cls, value: Path, info: ValidationInfo) -> Path:
        if not info.data.get("enabled"):
            return value
        if not value.exists():
            msg = f"Directory '{value}' does not exist"
            raise ValueError(msg)
        if not value.is_dir():
            msg = f"Path '{value}' is not a directory"
            raise ValueError(msg)
        return value