Geonature DB

Overview

This project provides a Dockerized PostgreSQL database for Geonature. The generated images are meant to be used for development and testing purposes.

The image exists in two versions:

• One including core modules : Occtax, Occhab, and the validation module
• One without core modules and extras : Monitoring, Export, and Dashboard

Requirements

• Docker installed on your system
• (optional, when building) Git installed on your system

Use prebuilt images

First, pull the image

docker pull ghcr.io/pnx-si/geonature-db:latest
# or with extras
docker pull ghcr.io/pnx-si/geonature-db-extra:latest

Then, run it

docker run -d \
    --name geonature-db \
    --rm \
    -p 5432:5432 \
    ghcr.io/pnx-si/geonature-db:latest
# or with extras
docker run -d \
    --name geonature-db \
    --rm \
    -p 5432:5432 \
    ghcr.io/pnx-si/geonature-db-extra:latest

Building the Image

To build the Geonature DB image, run the following command:

make build

This will clone the required Geonature modules, configure them, and build the Docker image.

Configuration

The following environment variables can be configured:

• tag: The tag of the Geonature DB image (default: stock)
• version: The version of the Geonature DB image (default: 2.15.2)
• user_pg: The PostgreSQL username (default: geonatadmin)
• password_pg: The PostgreSQL password (default: geonatadmin)
• pg_port: The PostgreSQL port (default: 5432)
• pg_database: The PostgreSQL database name (default: geonature2db)
• monitoring_version: The version of the monitoring module (default: 1.0.1)
• export_version: The version of the export module (default: 1.7.2)
• dashboard_version: The version of the dashboard module (default: 1.5.0)

Building the Image from a Dump

To build the Geonature DB image from a dump file, run the following command:

make build_from_dump dump_filename=<path/to/dump/file>

This will build the Docker image using the specified dump file. Pratical, if you want to create a new image from your existing PostgreSQL database.

Warning

When producing your dump file, it must be generated with custom format (https://www.postgresql.org/docs/current/app-pgdump.html)

Running the Container

To run the Geonature DB container, run the following command:

make run

This will start a new container from the built image and map port 5432 on the host machine to port 5432 in the container.

Of course, it is better to use the generated image name with a docker run command.

Running the Container from a Dump

To run the Geonature DB container from a dump file, run the following command:

make run_from_dump dump_filename=<path/to/dump/file>

This will start a new container from the built image and map port 5432 on the host machine to port 5432 in the container.

Of course, it is better to use the generated image name with a docker run command.

Author

Jacques Fize (https://github.com/jacquesfize)