From 79f377b75b3979f7ffd063d757484cf94d81c442 Mon Sep 17 00:00:00 2001
From: Frederic Minne <frederic.minne@uclouvain.be>
Date: Thu, 22 Feb 2024 10:52:04 +0100
Subject: [PATCH] add some documentation in compose files

---
 docker-compose.override.yml | 1 +
 docker-compose.proxy.yml    | 8 +++++---
 docker-compose.swarm.yml    | 1 +
 docker-compose.yml          | 1 +
 4 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/docker-compose.override.yml b/docker-compose.override.yml
index c322d58..906b380 100644
--- a/docker-compose.override.yml
+++ b/docker-compose.override.yml
@@ -1,3 +1,4 @@
+# Define open ports on the service
 version: '3.1'
 services:
   webserver:
diff --git a/docker-compose.proxy.yml b/docker-compose.proxy.yml
index 351f597..e336775 100644
--- a/docker-compose.proxy.yml
+++ b/docker-compose.proxy.yml
@@ -39,12 +39,14 @@ services:
     - ./deploy/proxy.conf:/etc/nginx/proxy.conf
     networks:
     - proxy
-    
+
 networks:
   proxy:
     name: proxy
+    external: true
+    # Comment the rest of the definition if the network is already defined outside of the compose file
+    # for example by running docker network create command
     attachable: true
     driver: overlay
     driver_opts:
-      encrypted: 1
-    external: true
\ No newline at end of file
+      encrypted: 1
\ No newline at end of file
diff --git a/docker-compose.swarm.yml b/docker-compose.swarm.yml
index b75e630..3825bb0 100644
--- a/docker-compose.swarm.yml
+++ b/docker-compose.swarm.yml
@@ -1,3 +1,4 @@
+# This is the docker swarm version writtent to run with nginxproxy
 version: '3.7'
 services:
   webserver:
diff --git a/docker-compose.yml b/docker-compose.yml
index f4141c1..3ae1f93 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,3 +1,4 @@
+# Basic compose file mainly used to build the container image
 version: '3.1'
 services:
   webserver:
-- 
GitLab