Docker image that automatically sync a nginx server with static source files in a git repository.

Go to file

Yohann D'ANELLO e3e32d4046 First version		2020-11-22 22:57:24 +01:00
Dockerfile	First version	2020-11-22 22:57:24 +01:00
README.md	First version	2020-11-22 22:57:24 +01:00
docker-hook	First version	2020-11-22 22:57:24 +01:00
entrypoint.sh	First version	2020-11-22 22:57:24 +01:00
nginx.conf	First version	2020-11-22 22:57:24 +01:00
update.sh	First version	2020-11-22 22:57:24 +01:00

README.md

Serveur Nginx statique auto-mis à jour via Git

Cette image Docker permet la mise en place d'un serveur Nginx dont les sources sont un site statique.

Cependant, cette image offre l'avantage de mettre à jour automatiquement le site dès lors que la branche master du dépôt Git est modifiée.

Configuration

On désignera par www.exemple.com le site sur lequel vous souhaitez héberger votre site. Sur votre dépôt Git, ajoutez un nouveau webhook déclenché à chaque événement push (cela suffit normalement) vers l'adresse https://www.exemple.com/trigger-ci.json.

Il vous suffit ensuite de lancer l'image Docker en renseignant la variable d'environnement MKDOCS_SERVER_GIT_URL par l'adresse de clonage HTTPS du dépôt Git. Par exemple, pour ce dépôt, il s'agit de l'adresse https://gitlab.com/animath/si/mkdocs-server-from-git.git.

Un exemple :

docker run -e NGINX_SERVER_GIT_URL=https://gitlab.com/me/mon-super-projet-nginx.git -p 8000:80 ynerant/nginx-server-from-git

Le résultat s'observe sur http://localhost:8000.

Il est recommandé d'utiliser docker-compose :

    nginx-static-server:
        image: ynerant/nginx-server-from-git
        ports:
            - 8000:80
        environment:
            - NGINX_SERVER_GIT_URL=https://gitlab.com/me/mon-super-projet.git

Si vous utilisez Traefik comme reverse-proxy :

    nginx-static-server:
        image: ynerant/nginx-server-from-git
        restart: always
        environment:
            - NGINX_SERVER_GIT_URL=https://gitlab.com/me/mon-super-projet.git
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.nginx-static-server.rule=Host(`www.exemple.com`)"
            - "traefik.http.routers.nginx-static-server.entrypoints=websecure"
            - "traefik.http.routers.nginx-static-server.tls.certresolver=mytlschallenge"

À vous bien sûr d'adapter la configuration comme bon vous semble.

Enjoy :)

Fonctionnement

L'image contient un serveur Nginx avec deux entrées : un serveur classique desservant le dossier /var/www/html et une entrée écoutant sur /trigger-ci.json écrite en Python afin de récupérer l'événement de push envoyé par le serveur Git.

À chaque push, le script update.sh est exécuté, visant simplement à effectuer un git pull afin de mettre à jour les fichiers.

Le dossier .git n'est pas desservi pour des raisons de sécurité.