Folksonomy API

Folksonomy is a service to allow contributors to freely add labels and values to products.

The code is at https://github.com/openfoodfacts/folksonomy_api/

Deployment

Folksonomy is deployed on a LXC container. (108 at the time of writing)

Code is in /home/folksonomy/folksonomy_api

It is started thanks to a systemd unit: folksonomy.service (config at /etc/systemd/system/folksonomy.service)

Server is running uvicorn on port 8000 with user folksonomy.

It is served behind the NGINX reverse proxy

The python environment has been setup using uv, to get python3.10 and poetry on top of that. So poetry executable is in /home/folksonomy/.local/bin/poetry

Useful commands

Status (reload/restart/etc.):

systemctl status folksonomy

See service logs:

sudo journalctl -u folksonomy

Upgrade

Before every upgrade, make a snapshot of the Proxmox container. Then:

# Switch to "folksonomy" user
su - folksonomy
cd ~/folksonomy_api
# Upgrade from git repository
git fetch
git checkout vX.y.z
# Install new depencies if any
poetry install
# DB migration process
poetry run yoyo apply --database postgresql:///folksonomy
# go back root
exit
# Finally, restart the service (with root user or root rights or sudo rights)
systemctl daemon-reload
systemctl restart folksonomy

Install

We simply clone the repository in /home/folksonomy/folksonomy_api.

We installed the python environment with uv:

# as root
pip install uv
/usr/local/bin/uv python install 3.10
# as folksonomy
su - folksonomy
uv tool install poetry --python=3.10
# ensure PATH is correct
which poetry
# /home/folksonomy/.local/bin/poetry

The systemd unit is linked from the repository

ln -s /home/folksonomy/folksonomy_api/confs/systemd/folksonomy.service /etc/systemd/system/folksonomy.service
systemctl daemon-reload