NGINX Unit
v. 1.20.0

Sanic§

To run apps built with the Sanic web framework using Unit:

  1. Install Unit with a Python 3.6+ language module.

  2. Create a virtual environment to install Sanic’s PIP package:

    $ cd /path/to/app/
    $ python3 -m venv venv
    $ source venv/bin/activate
    $ pip install sanic
    $ deactivate
    
  3. Let’s try a version of a tutorial app, saving it as /path/to/app/asgi.py:

    from sanic import Sanic
    from sanic.response import json
    
    app = Sanic()
    
    @app.route("/")
    async def test(request):
        return json({"hello": "world"})
    
  4. Set installation path permissions to secure access, for example:

    # chown -R app_user:app_group /path/to/app/
    

    Replace the placeholders above with actual values, noting them for later use in Unit configuration.

  5. Next, put together the Sanic configuration for Unit:

    {
        "listeners": {
            "*:80": {
                "pass": "applications/sanic_app"
            }
        },
    
        "applications": {
            "sanic_app": {
                "type": "python 3",
                "user": "app_user",
                "group": "app_group",
                "path": "/path/to/app/",
                "home": "/path/to/app/venv/",
                "module": "asgi",
                "callable": "app"
            }
        }
    }
    
  6. Upload the updated configuration. Assuming the JSON above was added to config.json:

    # curl -X PUT --data-binary @config.json --unix-socket \
           /path/to/control.unit.sock http://localhost/config/
    

    Note

    The control socket path may vary; run unitd --help or see Startup for details.

  7. After a successful update, your app should be available on the listener’s IP address and port:

    $ curl http://localhost
    
          {"hello":"world"}