Skip to content

Commit

Permalink
Merge pull request #24 from PnX-SI/develop
Browse files Browse the repository at this point in the history
Develop > Master / Release 2.13.4
  • Loading branch information
camillemonchicourt authored Dec 15, 2023
2 parents a24a896 + 905f76b commit 23f0461
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 28 deletions.
4 changes: 4 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

BASE_PROTOCOL="https" # do not change to http, unless you know how to fix traefik labels

HTTP_PORT=80
Expand All @@ -8,6 +9,9 @@ HOSTPORT="${HOST}" # set to ${HOST}:${HTTPS_PORT} if HTTPS_PORT is different fr

ACME_EMAIL="" # required for valid https certificates

UID=1000 # Change with the value returned by the command `id -u`
GID=1000 # Change with the value returned by the command `id -g`

GEONATURE_SUPERGRANT_ARGS="--group --nom Grp_admin" # comment this line to disable supergrant

GEONATURE_DB_LOCAL_SRID=4326 # must be correctly set on first run
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ jobs:
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
build-args: GEONATURE_BACKEND_IMAGE=ghcr.io/pnx-si/geonature-backend:2.13.3
build-args: GEONATURE_BACKEND_IMAGE=ghcr.io/pnx-si/geonature-backend:2.13.4

frontend:
name: Build geonature frontend docker image
Expand Down Expand Up @@ -92,4 +92,4 @@ jobs:
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
build-args: GEONATURE_FRONTEND_IMAGE=ghcr.io/pnx-si/geonature-frontend:2.13.3
build-args: GEONATURE_FRONTEND_IMAGE=ghcr.io/pnx-si/geonature-frontend:2.13.4
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ De plus, celui-ci fournit une image Docker de GeoNature contenant, outre les mod
- [Dashboard](https://github.com/PnX-SI/gn_module_dashboard)
- [Monitorings](https://github.com/PnX-SI/gn_module_monitorings)


## Démarrage rapide

- Installer Docker : [voir la documentation](https://docs.docker.com/engine/install/)
- Ajouter votre utilisateur courant au groupe `docker` : `sudo usermod -aG docker $USER` puis réouvrir sa session Linux ([voir la documentation](https://docs.docker.com/engine/install/linux-postinstall))
- Installer `git` (`sudo apt-get install git`)
- Clôner le dépôt : `git clone https://github.com/PnX-SI/GeoNature-Docker-services` ou extraire une [archive](https://github.com/PnX-SI/GeoNature-Docker-services/releases)
- Se placer dans le répertoire du dépôt : `cd GeoNature-Docker-services`
- Créer le fichier `.env` à partir du fichier d’exemple : `cp .env.sample .env`. Compléter les paramètres importants (`HOST`, `ACME_EMAIL`, `GEONATURE_LOCAL_SRID`, `POSTGRES_PASSWORD`).
- Créer le fichier `.env` à partir du fichier d’exemple : `cp .env.sample .env`. Compléter les paramètres importants (`HOST`, `ACME_EMAIL`, `GEONATURE_LOCAL_SRID`, `POSTGRES_PASSWORD`, `GID`, `UID`).
- Lancer la commande `./init-config.sh` afin de créer les fichiers de configuration suivants, avec des clés secrètes générées aléatoirement :
- `config/geonature/geonature_config.toml`
- `config/usershub/config.py`
Expand All @@ -25,17 +24,16 @@ De plus, celui-ci fournit une image Docker de GeoNature contenant, outre les mod

Les logs sont accessibles avec la commande `docker compose logs -f` ou `docker compose -f <nom du service>` (avec l'option `-n100` pour ne renvoyer que les 100 dernières lignes des logs).


## Les services

- `postgres` : la base de données
- `usershub` : la gestion des utilisateurs
- `taxhub` : la gestion du référentiel taxonomique
- `geonature-backend` : l’API de GeoNature
- `geonature-frontend` : l’interface web de GeoNature
- `geonature-worker` : exécution de certaines tâches de GeoNature en arrière-plan (import, export, mail, etc...)
- `redis` : service de communication entre le worker et le backend
- `traefik` : serveur web redirigeant les requêtes vers le bon service
- `postgres` : la base de données
- `usershub` : la gestion des utilisateurs
- `taxhub` : la gestion du référentiel taxonomique
- `geonature-backend` : l’API de GeoNature
- `geonature-frontend` : l’interface web de GeoNature
- `geonature-worker` : exécution de certaines tâches de GeoNature en arrière-plan (import, export, mail, etc...)
- `redis` : service de communication entre le worker et le backend
- `traefik` : serveur web redirigeant les requêtes vers le bon service

```
SERVICE PORTS
Expand All @@ -51,7 +49,6 @@ usershub 5001/tcp

![Schéma des services](docs/schema_services_0.1.png)


## Configuration

Voir la documentation des différentes applications pour renseigner les fichiers de configuration :
Expand All @@ -60,7 +57,7 @@ Voir la documentation des différentes applications pour renseigner les fichiers
- UsersHub : `./config/usershub/config.py` ([fichier d’exemple](https://github.com/PnX-SI/UsersHub/tree/master/config/config.py.sample))
- TaxHub : `./config/taxhub/config.py` ([fichier d’exemple](https://github.com/PnX-SI/TaxHub/apptax/config.py.sample))

Ces fichiers doivent contenir *a minima* le paramètre `SECRET_KEY`.
Ces fichiers doivent contenir _a minima_ le paramètre `SECRET_KEY`.
Vous pouvez générer automatiquement des fichiers vierges contenant des clés secrètes aléatoires avec le script `./init-config.sh`.

Si vous modifiez les fichiers de configuration de GeoNature, d'un de ses modules, de TaxHub ou de UsersHub, vous devez relancer les conteneurs Docker avec la commande `docker compose restart` (ou idéalement seulement le conteneur concerné, par exemple `docker compose restart usershub`).
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3.9"

x-defaults: &defaults
user: ${UID:-1000}:${GID:-1000}
user: ${UID}:${GID}

x-env-defaults: &env-defaults
http_proxy: ${HTTP_PROXY:-}
Expand Down
40 changes: 29 additions & 11 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
CHANGELOG
=========
# CHANGELOG

2.13.3 (2023-10-18)
------------------
## 2.13.4 (2023-12-15)

**🏷️ Versions**

- GeoNature 2.13.4
- TaxHub 1.12.1
- UsersHub 2.3.4
- GeoNature-dashboard 1.4.0
- GeoNature-export 1.6.0
- GeoNature-import 2.2.3
- GeoNature-monitoring 0.7.0

**✨ Améliorations**

- Le GID et le UID sont modifiables dans le fichier `.env` (#23 par @jacquesfize).

## 2.13.3 (2023-10-18)

**🏷️ Versions**

Expand All @@ -23,8 +37,9 @@ CHANGELOG
- Comme indiqué dans la procédure classique de mise à jour, vous devez télécharger la nouvelle version du dépôt (notamment pour mettre à jour le fichier `docker-compose.yml` qui a évolué dans cette version)
- Si vous l'aviez modifié localement, reportez les évolutions du fichier `docker-compose.yml` (#20), en y ajoutant les paramètres de TaxHub

2.13.2 (2023-09-28)
------------------
2.13.2 (2023-09-28)

---

**🏷️ Versions**

Expand All @@ -44,8 +59,9 @@ CHANGELOG

- Correction du chargement de la customisation (au niveau de GeoNature)

0.2.0 (2023-09-19)
------------------
0.2.0 (2023-09-19)

---

**🏷️ Versions**

Expand All @@ -60,7 +76,7 @@ CHANGELOG
**✨ Améliorations**

- Compléments de la documentation (Redirections, version, rebuild des images)
- Ajout de variables dans le `.env` pour pouvoir intégrer ou non les données initiales (référentiel de sensibilité, BDC statuts, zonages administratifs, mailles et données d'exemple)
- Ajout de variables dans le `.env` pour pouvoir intégrer ou non les données initiales (référentiel de sensibilité, BDC statuts, zonages administratifs, mailles et données d'exemple)

**🐛 Corrections**

Expand All @@ -79,14 +95,16 @@ Les modifications suivantes ont été apportées au fichier `docker-compose.yml`
USERSHUB_FILL_MD5_PASS: ${USERSHUB_FILL_MD5_PASS:-false}
```
- Ajout du paramètre `--schedule-filename` à la commande de Celery Beat :

```
services:
geonature-worker:
command: celery -A geonature.celery_app:app worker --beat --schedule-filename=/dist/media/celerybeat-schedule.db
```

0.1.0 (2023-09-15)
------------------
0.1.0 (2023-09-15)

---

Première version fonctionnelle de GeoNature-Docker-services, permettant de déployer, avec un seul fichier `docker-compose`, GeoNature et ses 4 modules externes principaux, TaxHub, UsersHub et traefik (comme reverse proxy et pour gérer les certificats SSL, générés automatiquement pour que les applications soient accessibles en HTTPS lors de leur installation).

Expand Down

0 comments on commit 23f0461

Please sign in to comment.