Postgres + Postgrest

This repository containes required software to run the backend for the TFM project.

Terrestrial Forest Monitor (TFM) Frontend

1. Download & Install Docker Desktop

https://docs.docker.com/desktop/install/ubuntu/

and

2. clone repository

!! To clone the repo AND submodules use the --recursive flag !!

git clone https://github.com/Thuenen-Forest-Ecosystems/TFM-postgres-docker.git

_{For employees of the Thünen Institute:}

git clone --recursive https://github.com/Thuenen-Forest-Ecosystems/TFM-postgres-docker.git

3. Change credentials

Copy the _.env file to .env and change the credentials for production.

4. Run

docker compose up

_{To run docker in background mode add -d}

Potgrest http://localhost:3000/

Swagger http://localhost:4080/

PgAdmin http://localhost:5050/pgadmin/

5. Stop & Remove

docker compose down --volumes

Test

docker compose --env-file ./_.env up
npm test

Setup pgAdmin

Add a connection to postGres by register a new Server. Add Host name (PGADMIN_HOST_NAME), username (POSTGRES_USER) and password (POSTGRES_PASSWORD) defined in your .env file.

Setup QGIS

Create "New Connection..." to your PostgreSQL server. Add Host name (PGADMIN_HOST_NAME), username (POSTGRES_USER) and password (POSTGRES_PASSWORD) defined in your .env file.

git

Fetch and merge (with submodules)

git pull --recurse-submodules

Push changes (with submodules)

git commit -am "commit message"
git push --recurse-submodules

Setup Webhooks on Server

Add a webhook to your repository to automatically build and deploy the docker container on push to main branch.

npm install
npm install pm2 -g
npm run start

This runs webhook/hook.js in background on http://localhost:4000/webhook and starts docker compose.

Next time you push to main, the webhook will be triggered and the docker container will be updated and restart automatically.

Local Development

You can use https://smee.io/ to create a webhook proxy to your local machine. Full tutorial

Release

To create a new release, create a new tag and push it to the repository.

git tag -a v0.0.1 -m "Initial Release"
git push origin v0.0.1

Recurring Errors

If "The CSRF session token is missing." error occures

Close pgadmin session in browser tab and retry.

Thuenen-Forest-Ecosystems / TFM-postgres-docker

readme