Skip to content

Commit

Permalink
Merge pull request #23 from PnX-SI/deal-with-uid-gid
Browse files Browse the repository at this point in the history
Resolving writting permission issue
  • Loading branch information
TheoLechemia authored Oct 24, 2023
2 parents c4abd19 + 9facc14 commit 4fc7218
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 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
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

0 comments on commit 4fc7218

Please sign in to comment.