Getting Started

Requirements

To run the server locally, you will need the following:

  • Python 3.9+

  • NodeJS

  • yarn

  • redis (strongly recommend a container)

  • PostgreSQL (strongly recommend a container)

To run the containers, you will need either one of the following installed:

  • Docker and Docker Compose

  • Podman

Note when using Podman 5+, default networking will not resolve localhost, and 127.0.0.1 should be used.

Running Locally

To run the server locally for development, you can use podman or docker-compose.

podman (Suggested)

To run Ibutsu using podman, use the ibutsu-pod.sh utility script. This will create a pod and add the necessary resources, and will mount the working directory into the containers.

uvicorn (backend) and node (frontend) are configured to automatically reload when files change, so you can edit the code and see the changes immediately.

$ ./scripts/ibutsu-pod.sh --create-admin --create-project --persistent

This will start up the containers and create an administrator and a project. It can also import archives and create a dashboard and widget with the appropriate options.

There are several more options available, run the script with --help to see them.

Docker Compose

There is a pre-created Docker Compose file for running a development environment locally.

The docker-compose.dev.yaml file will run python containers and do a local install for backend and frontend.

The docker-compose.yaml file will build containers using the appropriate dockerfiles and run the built images.

$ docker-compose -f docker-compose.dev.yaml
# OR
$ docker-compose -f docker-compose.yaml

Without Containers

Using either podman or Docker Compose is the recommended way to run Ibutsu locally. If you don’t want to use the containers, the following instructions should help you get up and running:

Run the Frontend

When running on your local computer, the server is made up of two parts, the frontend and the backend. The backend runs the api while the frontend hosts the UI. First, install yarn if you don’t have it already, and set up the frontend.

Many Linux distributions offer Yarn in their package repositories. Both Debian and Fedora package Yarn as yarnpkg.

Install Yarn on Fedora:

sudo dnf install -y yarnpkg

If you don’t want to use the packaged version of Yarn, you can install it via npm:

cd ibutsu-server/frontend
npm install yarn

Just remember that you’ll need to specify the full path when running Yarn:

node_modules/.bin/yarn <action>

Now that Yarn is installed, use Yarn to install the frontend’s dependencies:

yarn install

Then to start the development server for the frontend using yarn:

yarn run devserver

The development server features automatic reloading, so that whenever you make a change to your code, the server will rebuild your app and run the new code.

Open your browser and go to localhost:3000 to see the web UI.

Run PostgreSQL and Redis

Next you’ll need to set up a PostgreSQL server. It is easiest to just run the server in a container:

Note

In all these examples, we use podman, but you can substitute docker in its place.

podman run --publish 5432:5432 --name postgres -e POSTGRES_USER=ibutsu -e POSTGRES_PASSWORD=ibutsu -e POSTGRES_DB=ibutsu -d postgres

If you don’t have redis installed locally, you’ll want to also run a redis container. This is required for celery.

podman run --name redis -d -p "6379:6379" redis

Handle Dependencies

You’ll want to set up a virtual environment for the backend, and install the dependencies:

cd ibutsu-server/backend
python3.9 -m venv .ibutsu-env
source .ibtusu-env/bin/activate/
pip install -U pip wheel
pip install -U -r requirements-pinned.txt .

In order to update/maintain dependencies, the tool uv should be used.

Dependencies are defined in pyproject.toml, and are pinned to specific versions in requirements-pinned.txt.

In order to update pinned dependency versions, modify the hardcoded pin in pyproject.toml if applicable, and run uv pip compile pyproject.toml -o requirements-pinned.txt from the backend directory.

Run Celery Worker

Start the celery worker:

celery worker -E -A ibutsu_server.celery_app --loglevel=info

Note

The -E is necessary to send task related events to the celery task monitor.

(Optional) Start the celery task monitor:

.ibutsu-env/bin/python ibutsu_server/tasks/monitor.py

The task monitor checks the task queue for failures.

Run the API Backend

Create backend/settings.yaml, start with copying backend/default.settings.yaml

cp backend/default.settings.yaml backend/settings.yaml

Run the Ibutsu server backend using Python:

.ibutsu-env/bin/python -m ibutsu_server

By default, the backend runs on port 8080, so your backend URL will be http://localhost:8080