Open Food Facts

https://openfoodfacts.github.io/
Admin
Open Food Facts is an open, collaborative database of food products, including ingredients,...
Tokens:1,075,169
Snippets:13,252
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and run without Docker

Source: https://openfoodfacts.github.io/open-prices/community/INSTALL

Steps to set up dependencies, apply migrations, and start the server locally using uv.

```bash
# Install uv (Python dependency manager)
# see https://docs.astral.sh/uv/

# Install dependencies (pyproject.toml)
uv sync

# Apply migrations
uv run --env-file .env python manage.py migrate

# Run Locally
uv run --env-file .env python manage.py runserver

# Now the server will run on http://127.0.0.1:8000 !

# Note: you can change the port if you want
uv run python manage.py runserver 8001
```

--------------------------------

### Install from source

Source: https://openfoodfacts.github.io/openfoodfacts-python

Manual installation method by cloning the repository.

```bash
git clone https://github.com/openfoodfacts/openfoodfacts-python
cd openfoodfacts-python
pip install .  # Note the “.” at the end!
```

--------------------------------

### Install via pip

Source: https://openfoodfacts.github.io/openfoodfacts-python

The recommended method for installing the SDK.

```bash
pip install openfoodfacts
```

--------------------------------

### Install software-properties-common

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2025-07-08-osm45-gpu-passthrough

Install the required package to manage software repositories.

```bash
sudo apt install software-properties-common -y
```

--------------------------------

### Install Build-Essential and Utilities

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2022-11-09-monitoring-move-to-own-vm

Install build-essential, jq, and rsync for system management tasks.

```bash
$ sudo apt install build-essential jq rsync
```

--------------------------------

### Start new PostgreSQL instance

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2026-03-05-moving-postgres-to-scaleway

Start the PostgreSQL container on scaleway-docker-prod.

```bash
sudo -u off -i
cd /home/off/shared-org
docker compose start postgresql
```

--------------------------------

### Install ZFS utilities

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-09-24-kimsufi-stor-ks1-installation

Install the ZFS utilities and load the kernel module.

```bash
sudo apt install  zfsutils-linux
sudo /sbin/modprobe zfs

```

--------------------------------

### Install Nginx

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-03-14-off2-opff-reinstall

Installs the Nginx web server.

```bash
apt install nginx
```

--------------------------------

### Install make utility

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-04-12-install-off-query-off1

Command to install the make utility required for deployments.

```bash
apt install make
```

--------------------------------

### Install Docker Engine on Debian

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2022-11-09-monitoring-move-to-own-vm

Standard installation steps for Docker Engine on Debian, including repository setup and package installation.

```bash
sudo apt-get remove docker docker-engine docker.io containerd runc
sudo apt-get update
sudo apt-get install \
    ca-certificates \
    curl \
    gnupg \
    lsb-release
curl -fsSL https://download.docker.com/linux/debian/gpg | \
  sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin
sudo docker run hello-world
```

--------------------------------

### Start services with make

Source: https://openfoodfacts.github.io/openfoodfacts-server/dev/how-to-use-gitpod

Use this command to bring up the development environment.

```bash
$ make up  
```

--------------------------------

### Install generic system packages

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-06-07-off2-opf-obf-reinstall

Installs a set of base utilities and compilers required for the environment.

```bash
sudo apt install -y apache2 apt-utils g++ gcc less make gettext wget vim
```

--------------------------------

### Example API Request

Source: https://openfoodfacts.github.io/documentation/docs/Product-Opener/api/tutorials/contributing-to-image-refresh-api

A concrete example of a GET request for French images of product 3483130043180.

```text
https://fr.openfoodfacts.org/api/v2/produit/3483130043180?fields=images_to_update_fr
```

--------------------------------

### CPAN installation error log

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-04-26-off2-obf-new-install

Example of error output encountered during CPAN module installation when system dependencies are missing.

```text
! Configure failed for Imager-File-PNG-0.99. See /root/.cpanm/work/1716285902.64340/build.log for details.
! Configure failed for Imager-zxing-1.001. See /root/.cpanm/work/1716285902.64340/build.log for details.
! Configure failed for Imager-File-HEIF-0.005. See /root/.cpanm/work/1716285902.64340/build.log for details.
! Configure failed for Imager-File-WEBP-0.005. See /root/.cpanm/work/1716285902.64340/build.log for details.
! Configure failed for Imager-File-AVIF-0.002. See /root/.cpanm/work/1716285902.64340/build.log for details.
! Configure failed for Imager-File-JPEG-0.97. See /root/.cpanm/work/1716285902.64340/build.log for details.
! Installing the dependencies failed: Module 'Imager::File::AVIF' is not installed, Module 'Imager::File::JPEG' is not installed, Module 'Imager::File::PNG' is not installed, Module 'Imager::zxing' is not installed, Module 'Imager::File::WEBP' is not installed, Module 'Imager::File::HEIF' is not installed
! Bailing out the installation for ..
```

--------------------------------

### Install additional system tools

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-11-14-hetzner-server-install

Install common utility packages for server management.

```bash
apt install parted fail2ban molly-guard htop dstat
```

--------------------------------

### Get Nutella Ferrero Product Data

Source: https://openfoodfacts.github.io/openfoodfacts-server/api/tutorial-off-api

Example of a GET request to retrieve data for a specific product using its barcode.

```http
https://world.openfoodfacts.net/api/v2/product/3017624010701
```

--------------------------------

### Start development environment

Source: https://openfoodfacts.github.io/documentation/docs/Product-Opener/dev/how-to-use-gitpod

Use this command to bring up the development environment.

```bash
$ make up
```

--------------------------------

### Install fio for performance measurement

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2025-08-07-testing-virtiofs

Command to install the fio tool for measuring performance.

```bash
sudo apt install fio
```

--------------------------------

### ZFS dkms installation error log

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2025-11-27-creating-scaleway-zfs-nvme

Example of the error encountered during ZFS installation due to kernel version mismatches.

```text
...
Error! Module version 2.3.4-1~bpo13+1 for spl.ko
is not newer than what is already found in kernel 6.14.11-4-pve (2.3.4-pve1).
You may override by specifying --force.
...
Errors were encountered while processing:
 zfs-dkms
 proxmox-kernel-6.17.2-2-pve-signed
 proxmox-kernel-6.17
 proxmox-default-kernel
 proxmox-ve
```

--------------------------------

### Setup OPF distribution folders

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-06-07-off2-opf-obf-reinstall

Creates the distribution directory, transfers files, and sets up symbolic links for OPF.

```bash
sudo mkdir /srv/opf-dist
sudo chown off:off -R /srv/opf-dist
```

```bash
cp -r  /srv/opf-old/html/images/icons/dist /srv/opf-dist/icons
cp -r /srv/opf-old/html/css/dist  /srv/opf-dist/css
cp -r /srv/opf-old/html/js/dist  /srv/opf-dist/js
```

```bash
# first link for whole folder
ln -s /srv/opf-dist /srv/opf/dist
# relative links for the rest
ln -s ../../../dist/icons /srv/opf/html/images/icons/dist
ln -s ../../dist/css /srv/opf/html/css/dist
ln -s ../../dist/js /srv/opf/html/js/dist
ls -l  /srv/opf/dist /srv/opf/html/{images/icons,css,js}/dist
```

--------------------------------

### Install and test GeoIP update

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-03-14-off2-opff-reinstall

Installs the geoipupdate package and attempts to start the service. The initial attempt fails due to missing credentials.

```bash
sudo apt install geoipupdate
```

```bash
sudo systemctl start geoipupdate.service
sudo systemctl status geoipupdate.service
...
Process: 7819 ExecCondition=grep -q ^AccountID .*[^0]\+ /etc/GeoIP.conf (code=exited, stat>
        CPU: 2ms
...
mai 10 09:12:23 opff systemd[1]: geoipupdate.service: Skipped due to 'exec-condition'.
mai 10 09:12:23 opff systemd[1]: Condition check resulted in Weekly GeoIP update being skipped.
```

--------------------------------

### Install MongoDB 4.4 on Debian

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-01-03-mongodb-migration-off1

Commands to install MongoDB 4.4, including adding the repository key, configuring the sources list, and starting the service.

```bash
sudo apt-get install gnupg curl
curl -fsSL https://pgp.mongodb.com/server-4.4.asc | \
   sudo gpg -o /usr/share/keyrings/mongodb-server-4.4.gpg \
   --dearmor
echo "deb [ signed-by=/usr/share/keyrings/mongodb-server-4.4.gpg ] http://repo.mongodb.org/apt/debian buster/mongodb-org/4.4 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
sudo apt-get update
sudo apt-get install -y mongodb-org

sudo systemctl daemon-reload
sudo systemctl enable mongod
sudo systemctl start mongod
# verify
sudo systemctl status mongod
```

--------------------------------

### Setup OBF distribution folders

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-06-07-off2-opf-obf-reinstall

Creates the distribution directory, transfers files, and sets up symbolic links for OBF.

```bash
sudo mkdir /srv/obf-dist
sudo chown off:off -R /srv/obf-dist
```

```bash
cp -r  /srv/obf-old/html/images/icons/dist /srv/obf-dist/icons
cp -r /srv/obf-old/html/css/dist  /srv/obf-dist/css
cp -r /srv/obf-old/html/js/dist  /srv/obf-dist/js
```

```bash
# first link for whole folder
ln -s /srv/obf-dist /srv/obf/dist
# relative links for the rest
ln -s ../../../dist/icons /srv/obf/html/images/icons/dist
ln -s ../../dist/css /srv/obf/html/css/dist
ln -s ../../dist/js /srv/obf/html/js/dist
# verify
ls -l  /srv/obf/dist /srv/obf/html/{images/icons,css,js}/dist
```

--------------------------------

### GET /knowledge_panel Request

Source: https://openfoodfacts.github.io/documentation/docs/Knowledge-Panel/knowledge-panel/knowledge_panel_knowledge_panel_get

Example cURL request to the knowledge_panel endpoint with various query parameters.

```bash
curl -X GET "https://openfoodfacts.github.io/knowledge_panel?facet_tag=string&value_tag=string&sec_facet_tag=string&sec_value_tag=string&lang_code=string&country=string&include=last_edits&exclude=last_edits"
```

--------------------------------

### cURL request for images

Source: https://openfoodfacts.github.io/documentation/docs/Robotoff/image-management/getImages

Example request to retrieve images using the GET method with query parameters.

```bash
curl -X GET "https://robotoff.openfoodfacts.org/api/v1/images?count=25&page=1&server_type=off&barcode=5410041040807&with_predictions=false"
```

--------------------------------

### Initialize and store a product

Source: https://openfoodfacts.github.io/openfoodfacts-server/dev/ref-perl-pod/ProductOpener/Products.html

Demonstrates the basic workflow of initializing a product reference with user and organization IDs, updating product fields, and saving the changes to the database.

```perl
    use ProductOpener::Products qw/:all/;

        my $product_ref = init_product($User_id, $Org_id, $code, $countryid);

        $product_ref->{product_name_en} = "Chocolate cookies";

        store_product("my-user", $product_ref, 'helpful comment');
```

--------------------------------

### cURL Request for Nearest Neighbors

Source: https://openfoodfacts.github.io/documentation/docs/Robotoff/ann-search/searchNearestNeighborsByLogoId

Example cURL command to perform a GET request to the search endpoint.

```bash
curl -X GET "https://robotoff.openfoodfacts.org/api/v1/ann/search/{logo_id:int}?count=25&server_type=off"
```

--------------------------------

### Initialize ZFS utilities

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-11-14-hetzner-server-install

Install ZFS packages and load the kernel module.

```bash
apt install zfsutils-linux zfs-dkms
/sbin/modprobe zfs
```

--------------------------------

### Install QEMU Guest Agent

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2026-06-29-ovh-dockers-staging-upgrade

Install and enable the QEMU guest agent for better VM management.

```bash
sudo apt install qemu-guest-agent
sudo systemctl start qemu-guest-agent
sudo systemctl enable qemu-guest-agent
```

--------------------------------

### Git Setup and Repository Initialization

Source: https://openfoodfacts.github.io/facets-knowledge-panels/how-to-guides/CONTRIBUTING

Commands to clone the repository, configure the upstream remote, and synchronize with the main branch.

```bash
# Clone the repo
git clone https://github.com/<User-Name>/facets-knowledge-panels.git

# move to the folder
cd facets-knowledge-panels

# Add upstream remote
git remote add upstream https://github.com/openfoodfacts/facets-knowledge-panels.git

# Fetch and merge with upstream/main
git fetch upstream
git merge upstream/main

## Step 2: Create and Publish Working Branch
git checkout -b <type>/<issue-issueNumber>/{<additional-fixes>}

# Example: fix/issue-21
git push origin <type>/<issue-issueNumber>/{<additional-fixes>}
```

--------------------------------

### JSON response for get questions

Source: https://openfoodfacts.github.io/documentation/docs/Robotoff/question-management/getQuestionsByBarcode

Example of a successful 200 OK response body when no questions are available for the requested product.

```json
{
  "status": "no_questions",
  "questions": [
    {}
  ]
}
```

--------------------------------

### Create links for users and products

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-03-14-off2-opff-reinstall

Establish symbolic links for product and user data directories.

```bash
ln -s /mnt/opff/products /srv/opff/products
ln -s /mnt/opff/users /srv/opff/users
# old versions of Product opener needs users_emails.sto in /srv/xxx
ln -s /mnt/opff/users/users_emails.sto /srv/opff/users_emails.sto
```

--------------------------------

### Get image predictions via cURL

Source: https://openfoodfacts.github.io/documentation/docs/Robotoff/image-predictions/getImagePredictions

Example request to the image_predictions endpoint using cURL with various query parameters.

```bash
curl -X GET "https://robotoff.openfoodfacts.org/api/v1/image_predictions?count=25&page=1&server_type=off&barcode=5410041040807&model_name=universal-logo-detector&image_id=1&type=object_detection&model_version=string&min_confidence=0"
```

--------------------------------

### SearchParameters JSON Schema

Source: https://openfoodfacts.github.io/search-a-licious/devs/ref-python/types.html

JSON schema for the SearchParameters model, used for search requests common to GET and POST methods.

```json
{
   "title": "SearchParameters",
   "description": "Parameters for search, common to GET and POST",
   "type": "object",
   "properties": {
      "facets": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of facets to return in the response as a comma-separated value.\nIf None (default) no facets are returned.",
         "title": "Facets"
      },
      "charts": {
         "anyOf": [
            {
               "items": {
                  "anyOf": [
                     {
                        "$ref": "#/$defs/DistributionChart"
                     },
                     {
                        "$ref": "#/$defs/ScatterChart"
                     }
                  ]
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of vega representations to return in the response.\nCan be distribution chart or scatter plot.\n\nIf you pass a simple string, it will be interpreted as a distribution chart,\nor a scatter plot if it is two fields separated by a column (x_axis_field:y_axis_field).",
         "title": "Charts"
      },
      "fields": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "List of fields to include in the response. All other fields will be ignored.",
         "title": "Fields"
      },
      "page_size": {
         "default": 10,
         "description": "Number of results to return per page.",
         "title": "Page Size",
         "type": "integer"
      },
      "page": {
         "default": 1,
         "description": "Number of results to return per page.",
         "title": "Page",
         "type": "integer"
      },
      "sort_by": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Field name to use to sort results,\nthe field should exist and be sortable.\nIf it is not provided, results are sorted by descending relevance score.\n(aka best match)\n\nIf you put a minus before the name, the results will be sorted by descending order.\n\nIf the field name match a known script (defined in your configuration),\nit will be use for sorting.\n\nIn this case you also need to provide additional parameters corresponding to your script parameters.\nIf a script needs parameters, you can only use the POST method.\n\nBeware that this may have a big [impact on performance][perf_link]\n\nAlso bare in mind [privacy considerations][privacy_link] if your script parameters contains sensible data.\n\n[perf_link]: https://openfoodfacts.github.io/search-a-licious/users/how-to-use-scripts/#performance-considerations\n[privacy_link]: https://openfoodfacts.github.io/search-a-licious/users/how-to-use-scripts/#performance-considerations",
         "title": "Sort By"
      },
      "q": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null
```

--------------------------------

### cURL request for external sources

Source: https://openfoodfacts.github.io/documentation/docs/Product-Opener/v3/knowledge-panels/get-api-v3-external-sources

Example of a GET request to retrieve external knowledge panel sources using cURL.

```bash
curl -X GET "https://world.openfoodfacts.org/api/v3/external_sources" \
  -H "User-Agent: "
```

--------------------------------

### Configure bootloader via chroot

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-03-separate-hdd-docker-vms

Bind system directories, enter the new root environment, and install GRUB on the new disk.

```bash
for dir in sys proc dev; do mount --bind /$dir /mnt/new-root/$dir; done
ls -l /mnt/new-root/{sys,proc,dev}
chroot /mnt/new-root/
grub-install /dev/sdb
update-grub
exit
```

--------------------------------

### Get Nutella Ferrero Product Data

Source: https://openfoodfacts.github.io/documentation/docs/Product-Opener/api/tutorial-off-api

An example request path for the product Nutella Ferrero using its barcode 3017624010701.

```text
https://world.openfoodfacts.net/api/v2/product/3017624010701
```

--------------------------------

### Configure netplan nameservers

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-09-24-kimsufi-stor-ks1-installation

Example configuration for /etc/netplan/50-cloud-init.yaml to include the openfoodfacts.org search domain.

```yaml
network:
    version: 2
    ethernets:
        eno3:
            (...)
            nameservers:
                search: [openfoodfacts.org]
```

--------------------------------

### GET /api/v1/locations cURL request

Source: https://openfoodfacts.github.io/documentation/docs/Open-prices/locations/locations_list

Example cURL command to retrieve a list of locations using various query parameters.

```bash
curl -X GET "https://openfoodfacts.github.io/api/v1/locations?order_by=string&osm_address_city__like=string&osm_address_country__like=string&osm_name__like=string&page=0&price_count=0&price_count__gte=0&price_count__lte=0&size=0&type=ONLINE"
```

--------------------------------

### Preview documentation locally

Source: https://openfoodfacts.github.io/open-prices/community/CONTRIBUTING

Start the mkdocs server to preview documentation at http://127.0.0.1:8765.

```bash
uv run mkdocs serve -a 127.0.0.1:8765
```

--------------------------------

### cURL request for render-to-html

Source: https://openfoodfacts.github.io/documentation/docs/Knowledge-Panel/render-to-html/render_html_render_to_html_get

Example cURL command to perform a GET request to the render-to-html endpoint with various query parameters.

```bash
curl -X GET "https://openfoodfacts.github.io/render-to-html?facet_tag=string&value_tag=string&sec_facet_tag=string&sec_value_tag=string&lang_code=string&country=string&include=last_edits&exclude=last_edits"
```

--------------------------------

### Set container boot and protection options

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-04-26-off2-obf-new-install

Configure the container to start on boot and enable protection.

```text
onboot: 1
protection: 1

```

--------------------------------

### Get taxonomy-based suggestions (v3 API)

Source: https://openfoodfacts.github.io/openfoodfacts-server/api/ref-cheatsheet

Examples of querying the v3 taxonomy suggestions endpoint for synonyms, categories, and packaging materials.

```http
https://world.openfoodfacts.org/api/v3/taxonomy_suggestions?tagtype=labels&lc=fr&string=f&get_synonyms=1
```

```http
https://world.openfoodfacts.org/api/v3/taxonomy_suggestions?tagtype=categories&string=organic
```

```http
https://world.openfoodfacts.org/api/v3/taxonomy_suggestions?tagtype=packaging_materials&shape=box
```

--------------------------------

### cURL Request for Product Tags

Source: https://openfoodfacts.github.io/documentation/docs/folksonomy/product-tags/product_tags_list_product__product__get

Example cURL command to retrieve product tags using the GET method with Authorization header.

```bash
curl -X GET "https://api.folksonomy.openfoodfacts.org/product/string?owner=&keys=string" \
  -H "Authorization: Bearer "
```

--------------------------------

### Deploy monitoring

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/ansible

Run the monitoring playbook.

```bash
ansible-playbook sites/monitoring.openfoodfacts.org.yml
```

--------------------------------

### cURL request to get questions by barcode

Source: https://openfoodfacts.github.io/documentation/docs/Robotoff/question-management/getQuestionsByBarcode

Example request to the Robotoff API using cURL to retrieve questions for a specific product barcode.

```bash
curl -X GET "https://robotoff.openfoodfacts.org/api/v1/questions/5410041040807?count=1&server_type=off&lang=en&insight_types=brand%2Clabel"
```

--------------------------------

### Run VM configuration playbook

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2025-12-16-setting-up-query-postgres-replication

Execute the configuration playbook for the new VM.

```bash
ansible-playbook jobs/configure.yml -l hetzner-docker-prod
```

--------------------------------

### Retrieve price tags via cURL

Source: https://openfoodfacts.github.io/documentation/docs/Open-prices/price-tags/price_tags_list

Example request to fetch price tags using the GET method with various query parameters.

```bash
curl -X GET "https://openfoodfacts.github.io/api/v1/price-tags?created__gte=2019-08-24T14%3A15%3A22Z&created__lte=2019-08-24T14%3A15%3A22Z&order_by=string&page=0&prediction_count=0&prediction_count__gte=0&prediction_count__lte=0&price_id=0&proof__location__osm_address_country_code=string&proof__owner=string&proof__ready_for_price_tag_validation=true&proof_id=0&size=0&status=0&status__isnull=true&tags__contains=string&tags__not_contains=string"
```

--------------------------------

### Install Nginx, PHP, and MariaDB

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2021-02-22-matomo-install

Commands to install necessary packages and set permissions for the web directory.

```bash
$ ssh -i ~/.ssh/id_rsa -J CharlesNepote@ovh1.openfoodfacts.org CharlesNepote@10.1.0.107
$ sudo apt install nginx php7.3-{fpm,cli,curl,gd,imap,json,mbstring,mysql,xml,zip} mariadb-server
$ sudo chmod 755 -R /var/www/html/
$ sudo chown www-data:www-data -R /var/www/html/


$ sudo nano /etc/nginx/sites-available/default
location ~ \.php$ {
include snippets/fastcgi-php.conf;
```

--------------------------------

### cURL request for image cropping

Source: https://openfoodfacts.github.io/documentation/docs/Robotoff/image-processing/cropImage

Example cURL command to perform a GET request to the crop endpoint with specified image URL and coordinate parameters.

```bash
curl -X GET "https://robotoff.openfoodfacts.org/api/v1/images/crop?image_url=https%3A%2F%2Fimages.openfoodfacts.org%2Fimages%2Fproducts%2F541%2F004%2F104%2F0807%2F3.jpg&y_min=0&x_min=0&y_max=0&x_max=0"
```

--------------------------------

### Install system and Perl dependencies via apt

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-04-26-off2-obf-new-install

Executes a sudo apt install command to set up the necessary environment packages on the obf-new server.

```bash
sudo  apt install -y \
   apache2 \
   apt-utils \
   cpanminus \
   g++ \
   gcc \
   less \
   libapache2-mod-perl2 \
   make \
   gettext \
   wget \
   imagemagick \
   graphviz \
   tesseract-ocr \
   lftp \
   gzip \
   tar \
   unzip \
   zip \
   libtie-ixhash-perl \
   libwww-perl \
   libimage-magick-perl \
   libxml-encoding-perl  \
   libtext-unaccent-perl \
   libmime-lite-perl \
   libcache-memcached-fast-perl \
   libjson-pp-perl \
   libclone-perl \
   libcrypt-passwdmd5-perl \
   libencode-detect-perl \
   libgraphics-color-perl \
   libbarcode-zbar-perl \
   libxml-feedpp-perl \
   liburi-find-perl \
   libxml-simple-perl \
   libexperimental-perl \
   libapache2-request-perl \
   libdigest-md5-perl \
   libtime-local-perl \
   libdbd-pg-perl \
   libtemplate-perl \
   liburi-escape-xs-perl \
   libmath-random-secure-perl \
   libfile-copy-recursive-perl \
   libemail-stuffer-perl \
   liblist-moreutils-perl \
   libexcel-writer-xlsx-perl \
   libpod-simple-perl \
   liblog-any-perl \
   liblog-log4perl-perl \
   liblog-any-adapter-log4perl-perl \
   libgeoip2-perl \
   libemail-valid-perl \
   libmath-fibonacci-perl \
   libev-perl \
   libprobe-perl-perl \
   libmath-round-perl \
   libsoftware-license-perl \
   libtest-differences-perl \
   libtest-exception-perl \
   libmodule-build-pluggable-perl \
   libclass-accessor-lite-perl \
   libclass-singleton-perl \
   libfile-sharedir-install-perl \
   libnet-idn-encode-perl \
   libtest-nowarnings-perl \
   libfile-chmod-perl \
   libdata-dumper-concise-perl \
   libdata-printer-perl \
   libdata-validate-ip-perl \
   libio-compress-perl \
   libjson-maybexs-perl \
   liblist-allutils-perl \
   liblist-someutils-perl \
   libdata-section-simple-perl \
   libfile-which-perl \
   libipc-run3-perl \
   liblog-handler-perl \
   libtest-deep-perl \
   libwant-perl \
   libfile-find-rule-perl \
   liblinux-usermod-perl \
   liblocale-maketext-lexicon-perl \
   liblog-any-adapter-tap-perl \
   libcrypt-random-source-perl \
   libmath-random-isaac-perl \
   libtest-sharedfork-perl \
   libtest-warn-perl \
   libsql-abstract-perl \
   libauthen-sasl-saslprep-perl \
   libauthen-scram-perl \
   libbson-perl \
   libclass-xsaccessor-perl \
   libconfig-autoconf-perl \
   libdigest-hmac-perl \
   libpath-tiny-perl \
   libsafe-isa-perl \
   libspreadsheet-parseexcel-perl \
   libtest-number-delta-perl \
   libdevel-size-perl \
   gnumeric \
   libreadline-dev \
   libperl-dev \
   cmake \
   pkg-config \
   libapache2-mod-perl2-dev \
   libavif-dev \
   libde265-dev \
   libheif-dev \
   libjpeg-dev \
   libpng-dev \
   libwebp-dev \
   libx265-dev
```

--------------------------------

### Fetch Product Data from Staging Environment

Source: https://openfoodfacts.github.io/documentation/docs/Product-Opener/api

Example of how to perform a GET request to the staging API using HTTP Basic Authentication with the credentials 'off:off'.

```javascript
fetch("https://world.openfoodfacts.net/api/v3.6/product/3274080005003.json", {
  method: "GET",
  headers: { Authorization: "Basic " + btoa("off:off") },
})
  .then((response) => response.json())
  .then((json) => console.log(json));
```

--------------------------------

### Get partial taxonomy entries (v2 API)

Source: https://openfoodfacts.github.io/openfoodfacts-server/api/ref-cheatsheet

Examples of querying the v2 taxonomy endpoint to retrieve specific taxonomy entries with field filtering and language context.

```http
https://world.openfoodfacts.org/api/v2/taxonomy?tagtype=labels&tags=en:organic,en:fair-trade&fields=name,description,children&include_children=1&lc=en,fr
```

```http
https://world.openfoodfacts.org/api/v2/taxonomy?tagtype=categories&tags=en:carrot-juices&fields=name,parents,children,wikidata,auth_url&lc=en,fr&cc=fr
```

--------------------------------

### Install unzip dependency

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-11-28-google-drive-backup-setup

Install the unzip utility required for the Rclone installation process.

```bash
sudo apt install unzip
```

--------------------------------

### Deploy stunnel-client playbook

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2026-04-01-moving-open-prices-to-scaleway-03

Run the stunnel-client playbook to apply the configuration.

```bash
ansible-playbook sites/stunnel-client.yml --tags stunnel -l scaleway-stunnel-client
```

--------------------------------

### Create tutorial.html search interface

Source: https://openfoodfacts.github.io/search-a-licious/users/tutorial

A basic HTML file structure using Search-a-licious web components to build a functional search page.

```html
<!DOCTYPE html>
<html>
<head>
    <title>Search-a-licious tutorial</title>
    <!-- this makes the various searchalicious components available -->
    <script type="module" src="./search-a-licious.bundled.js"></script>
</head>
<body>
  <div id="search-bar">
  <!-- the search bar where you can add text -->
  <searchalicious-bar></searchalicious-bar>
  <!-- the button to launch the search -->
  <searchalicious-button></searchalicious-button>
  <!-- sorting -->
  <searchalicious-sort auto-refresh>
    <searchalicious-sort-field field="nutriscore_grade">Best nutriscore</searchalicious-sort-field>
    <searchalicious-sort-field field="-nutriscore_grade">Worst nutriscore</searchalicious-sort-field>
  </searchalicious-sort>
  </div>
  <div id="results">
  <!-- display of results -->
  <searchalicious-results>
    <!-- this define a template for results. We can use ${} expression with a result object containing result fields -->
    <template slot="result">
      <li>
        <a href="https://world.openfoodfacts.org/${result.code}">${result.product_name}</a>
        − Nutri-Score: ${result.nutriscore_grade}
      </li>
    </template>
  </searchalicious-results>
  <!-- a small display of the number of results -->
  <searchalicious-count></searchalicious-count>
  <!-- pagination -->
  <searchalicious-pages></searchalicious-pages>
  </div>
</body>
</html>
```

--------------------------------

### Install PostgreSQL APT repositories

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2025-09-02-off2-postgres-migration

Install the necessary packages and run the script to add the official PostgreSQL APT repositories.

```bash
sudo apt install -y postgresql-common gnupg2
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
```

--------------------------------

### Run post-installation script

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/explanation/proxmox

Execute the management script on the Proxmox host to perform initial container configuration.

```bash
sudo /root/cluster-scripts/ct_postinstall
```

--------------------------------

### Install nvidia-driver

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2025-07-08-osm45-gpu-passthrough

Install the recommended NVIDIA driver package.

```bash
sudo apt install nvidia-driver
```

--------------------------------

### Configure servers

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/ansible

Run the configuration playbook for all servers or a specific one.

```bash
ansible-playbook jobs/configure.yml
```

```bash
ansible-playbook jobs/configure.yml -l <server-name>
```

--------------------------------

### Navigate to project directory

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-11-22-create-clone-of-opff-for-keycloak-testing

Initial commands to access the project directory and switch to root user.

```bash
 cd /srv/opff
 sudo su
```

--------------------------------

### Install memcached

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-07-off2-off-reinstall

Install the memcached package inside the container.

```bash
apt install memcached
```

--------------------------------

### Start the development environment

Source: https://openfoodfacts.github.io/documentation/docs/Product-Opener/dev/how-to-develop-producer-platform

Use this command in the pro shell to start the development environment. Run make build_lang if CSS issues occur.

```makefile
make dev
```

```makefile
make build_lang
```

--------------------------------

### Install Rclone

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-11-28-google-drive-backup-setup

Execute the official Rclone installation script.

```bash
sudo -v ; curl https://rclone.org/install.sh | sudo bash
```

--------------------------------

### Install prometheus-mongodb-exporter

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-02-20-exporter-on-mongodb-ct

Installs the prometheus-mongodb-exporter package using apt.

```bash
sudo apt install prometheus-mongodb-exporter
```

--------------------------------

### Format new disk with parted

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-03-separate-hdd-docker-vms

Initialize the new disk with an msdos label, create a primary ext4 partition, and set the boot flag.

```bash
parted /dev/sdb mklabel msdos
parted /dev/sdb mkpart primary ext4 0% 100%
parted /dev/sdb set 1 boot on
parted /dev/sdb print
```

--------------------------------

### Verify Git Installation

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2022-11-09-monitoring-move-to-own-vm

Check the installed version of git.

```bash
$ git --version
git version 2.30.2
```

--------------------------------

### Create distribution directory

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-07-off2-off-reinstall

Sets up the directory for the frontend distribution.

```bash
# off or off-pro
declare -x SERVICE=off

sudo -E mkdir /srv/$SERVICE-dist
sudo -E chown off:off -R /srv/$SERVICE-dist
```

--------------------------------

### Install cuDNN

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2025-07-08-osm45-gpu-passthrough

Install the cuDNN library compatible with CUDA 12.

```bash
sudo apt-get -y install libcudnn9-cuda-12
```

--------------------------------

### Start PostgreSQL and Minion services

Source: https://openfoodfacts.github.io/documentation/docs/Product-Opener/dev/how-to-develop-producer-platform

Run this command in a non-pro shell to start the necessary background services for product import/export.

```bash
docker compose up postgres minion
```

--------------------------------

### Install zxing-cpp from source

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2024-04-26-off2-obf-new-install

Compiles and installs zxing-cpp version 2.1.0 from source to satisfy dependency requirements.

```bash
  set -x && \
    cd /tmp && \
    wget https://github.com/zxing-cpp/zxing-cpp/archive/refs/tags/v2.1.0.tar.gz && \
    tar xfz v2.1.0.tar.gz && \
    cmake -S zxing-cpp-2.1.0 -B zxing-cpp.release \
    -DCMAKE_INSTALL_PREFIX=/usr \
    -DCMAKE_BUILD_TYPE=Release \
    -DBUILD_WRITERS=OFF -BUILD_READERS=ON -DBUILD_EXAMPLES=OFF && \
    cmake --build zxing-cpp.release -j8 && \
    cmake --install zxing-cpp.release && \
    cd / && \
    rm -rf /tmp/v2.1.0.tar.gz /tmp/zxing-cpp*
```

--------------------------------

### Install PostgreSQL packages

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2023-07-off2-off-reinstall

Installs the standard PostgreSQL distribution packages.

```bash
sudo apt install postgresql postgresql-contrib
```

--------------------------------

### Install PaddleX serving plugin

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2026-06-02-install-paddlex

Execute the installation command for the PaddleX serving plugin inside the running container.

```bash
paddlex --install serving
```

--------------------------------

### Install NVIDIA Container Toolkit

Source: https://openfoodfacts.github.io/openfoodfacts-infrastructure/reports/2025-07-08-osm45-gpu-passthrough

Install the toolkit to enable GPU support in Docker and restart the service.

```bash
sudo apt-get install nvidia-container-toolkit
sudo systemctl restart docker
```
Tokens:
Raw