Linux (recommended)

These instructions are intended for the person who administers the instance, usually a more technical/operational profile.

Prerequisites (Ubuntu)

1. Install dependencies:

sudo apt update && sudo apt install -y git docker.io docker-compose-plugin

1. Add your user to the Docker group:

sudo usermod -aG docker $USER

1. Log out and log back in to apply the group permission.

Note:

• If you do not have root permissions, use sudo when necessary.

Installation

1. Download the repository and enter the folder:

git clone https://gitlab.com/yndexa/farinha.git
cd farinha

1. Start Farinha:

./run.sh

On the first run, run.sh automatically creates the .env file from .env-sample.

The script also asks for the public Farinha URL. If you do not know it yet, press Enter to leave it blank and continue. You can edit .env later.

SECRET_KEY is generated automatically, without requiring Django to be installed on the server. The automatic key does not contain $.

If you create a SECRET_KEY manually and it contains $, the script warns that Docker Compose may interpret this character as an environment variable and offers to generate a new safe key.

Optional manual adjustment

If you need to review or change settings, open .env with your preferred text editor:

nano .env

Updating

1. Enter the folder where Farinha was installed:

cd farinha

1. Stop, update, and start again:

./down.sh && git pull && ./run.sh