With Docker

The easiest way to run RootDB is to use our officials Docker images, with compose plugin to start all services.

Download ready-to-use archives

We provide different set of Docker env & compose configuration files in the table below.
You will be able to quickly test locally.

Simply download one of the .zip files in the table below, extract it, and open a terminal in the extracted directory.

All set of Docker `.env` & `compose` files with default API and frontend configuration files.
Services	Notes	Configuration files
All-in-one (docker-compose)	Contains everything and works out-of-the box, ideal to test in local. TLDR : Download the archive, extract, go into the extracted directory and run : docker compose --env-file env up RootdB will be available at : localhost:8091	`rdb_mariadb_memcached.zip`
All-in-one (podman-kube)	Thanks to ullgren, you can also use a podman-kube manifest that contains everything and works out-of-the box, ideal to test in local. TLDR : Download the podman-kube.yaml file, and in the directory containing the file : # start podman play kube --start podman-kube.yaml # stop podman play kube --down podman-kube.yaml RootdB will be available at : localhost:8091	`podman-kube.yaml`

Caution

If the current user which will start services has a user id or group id different from 1000, you have to update docker env variables UID & GID with the right values.

To find-out your current user id & group id, use the command id

docker `env` Variables explanation
Note	Description
`DATA_DIR`	Relative or full path to the directory which (will) contains RootDB code. (/var/www directory inside the container)
`DB_DATA_DIR`	Relative or full path to the directory which (will) contains MariaDB data.
`API_ENV_PATHNAME`	Relative or full path to API configuration file. ( `api_env` )
`FRONTEND_APP_CONFIG_PATHNAME`	Relative or full path to frontend configuration file. ( `app-config.js` )
`UID`	User ID ( default : 1000 )
`GID`	Group ID ( default : 1000 )

Before starting services

For log, at this point you should have a directory named, for instance, rootdb, and inside, these files and directories :

.
├── [drwxr-xr-x] db
├── [-rw-r--r--] api_env
├── [-rw-r--r--] app-config.js
├── [-rw-r--r--] docker-compose.yml
└── [-rw-r--r--] env

Starting services

$ docker compose --env-file env -f docker-compose.yml up

Once containers are up and running the application should take ~6s to initialize, for the first launch. (once images are downloaded)

And you should see :

rootdb              | [16-Jun-2022 21:43:49] NOTICE: fpm is running, pid 1
rootdb              | [16-Jun-2022 21:43:49] NOTICE: ready to handle connections

Tip

It’s now time to setup the application.