deckar01 / mod-wsgi-van

🚐 Dynamically route mod_wsgi to mod_vhost_alias

mod-wsgi-van 🚐

Dynamically route mod_wsgi to mod_vhost_alias.

Features

• Isolate virtual environments between vhosts
• Automatically reload deployed vhosts
• Automatically unload deleted vhosts
• Symlinked vhost support

Overview

The router checks the HTTP_HOST on request to decide which vhosts it should be routed to. WSGI apps are lazy loaded. WSGI directories are monitored for mtime changes by default. Symlinks are resolved on access to support deploys that symlink vhosts.

Concerns

• Modules belonging to different vhosts are loaded into the same mod_wsgi process by default.
• Modules loaded outside of an app are shared between all apps in a process.

Install

sudo -H python -m pip install mod-wsgi-van

Example

# /etc/apache2/sites-available/vhosts.conf

<VirtualHost *:80>
    UseCanonicalName Off
    ServerAlias *.domain.org
    VirtualDocumentRoot "/var/www/%0/static"

    WSGIDaemonProcess example
    WSGIProcessGroup example
    WSGIScriptAlias /example /var/wsgi/example.py
</VirtualHost>

# /var/wsgi/example.py

from mod_wsgi_van import Router

application = Router().application

mkdir -p /var/www/example.domain.org/static
mkdir -p /var/www/example.domain.org/wsgi
python -m venv /var/www/example.domain.org/.venv
/var/www/example.domain.org/.venv/bin/python -m pip install Flask

# /var/www/example.domain.org/wsgi/app.py

from flask import Flask

app = Flask(__name__)
...

API

• Router
  • Attributes
    • base_path: str = "/var/www" - The location of the vhosts.
    • venv_name: str = ".venv" - The name of the virtual environment directory inside the vhost.
    • wsgi_dir: str = "wsgi" - The name of the WSGI directory inside the vhost.
    • module_name: str = "app" - The name of the module inside of the WSGI directory.
    • object_name: str = "app" - The name of the object inside of the module.
    • update_interval: float = 1.0 - The interval for polling symlinks in seconds.
  • Methods
    • get_server_path(host_name: str) -> pathlib.Path - Override to change the vhost naming scheme.
    • get_venv_paths(path: pathlib.Path) -> list[pathlib.Path] - Override to change the venv site packages locations.
    • get_version(path: pathlib.Path) -> Any - Override to customize the change detection strategy.