Gillotina

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

Install Unit with a Python 3.7+ language module.

Create a virtual environment to install Guillotina’s PIP package, for instance:

$ cd /path/to/app/  # Path to the application directory; use a real path in your configuration
$ python --version  # Make sure your virtual environment version matches the module version
      Python X.Y.Z  # Major version, minor version, and revision number
$ python -m venv venv  # Arbitrary name of the virtual environment
$ source venv/bin/activate  # Name of the virtual environment from the previous command
$ pip install guillotina
$ deactivate

Warning:
Create your virtual environment with a Python version that matches the language module from Step 1 up to the minor number (X.Y in this example). Also, the app type in Step 5 must resolve to a similarly matching version; Unit doesn’t infer it from the environment.

Let’s try a version of the tutorial app, saving it as /path/to/app/asgi.py:

from guillotina import configure
from guillotina import content
from guillotina import schema
from guillotina.factory import make_app
from zope import interface


class IMyType(interface.Interface):
   textline = schema.TextLine()


@configure.contenttype(
   type_name="MyType",
   schema=IMyType,
   behaviors=["guillotina.behaviors.dublincore.IDublinCore"],
)
class MyType(content.Resource):
   pass


@configure.service(
   context=IMyType,
   method="GET",
   permission="guillotina.ViewContent",
   name="@textline",
)
async def textline_service(context, request):
   return {"textline": context.textline}


# Callable name that Unit looks for
application = make_app(
   settings={
      "applications": ["__main__"],
      "root_user": {"password": "root"},
      "databases": {
            "db": {"storage": "DUMMY_FILE", "filename": "dummy_file.db"}
      },
   }
)

Note that all server calls and imports are removed.

Change ownership:

Run the following command (as root) so Unit can access the application directory (If the application uses several directories, run the command for each one):
console
# chown -R unit:unit /path/to/app/ # User and group that Unit's router runs as by default
```
# chown -R unit:unit /path/to/app/  # User and group that Unit's router runs as by default
   
```
The unit:unit user-group pair is available only with official packages , Docker images, and some third-party repos. Otherwise, account names may differ; run the ps aux | grep unitd command to be sure.

For further details, including permissions, see the security checklist.

Next, prepare the Guillotina configuration for Unit (use real values for type, home, and path):

{
   "listeners": {
      "*:80": {
         "pass": "applications/guillotina"
      }
   },
   "applications": {
      "guillotina": {
         "type": "python 3.Y",
         "type_comment": "Must match language module version and virtual environment version",
         "path": "/path/to/app/",
         "path_comment": "Path to the ASGI module",
         "home": "/path/to/app/venv/",
         "home_comment": "Path to the virtual environment, if any",
         "module": "asgi",
         "module_comment": "ASGI module filename with extension omitted",
         "protocol": "asgi",
         "protocol_comment": "Protocol hint for Unit, required to run Guillotina apps"
      }
   }
}

Upload the updated configuration.

Assuming the JSON above was added to config.json. Run the following command as root:

# curl -X PUT --data-binary @config.json --unix-socket \
      /path/to/control.unit.sock \  # Path to Unit's control socket in your installation
      http://localhost/config/      # Path to the config section in Unit's control API
   

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

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

$ curl -XPOST --user root:root http://localhost/db \
       -d '{ "@type": "Container", "id": "container" }'

      {"@type":"Container","id":"container","title":"container"}

$ curl --user root:root http://localhost/db/container

      {
          "@id": "http://localhost/db/container",
          "@type": "Container",
          "@name": "container",
          "@uid": "84651300b2f14170b2b2e4a0f004b1a3",
          "@static_behaviors": [
          ],
          "parent": {
          },
          "is_folderish": true,
          "creation_date": "2020-10-16T14:07:35.002780+00:00",
          "modification_date": "2020-10-16T14:07:35.002780+00:00",
          "type_name": "Container",
          "title": "container",
          "uuid": "84651300b2f14170b2b2e4a0f004b1a3",
          "__behaviors__": [
          ],
          "items": [
          ],
          "length": 0
      }

Last modified February 6, 2025