Merge pull request #317 from dedis/docker-improvements

feat: minor improvements in the Docker environment

Author: PascalinDe

.dockerignore

@@ -0,0 +1,5 @@
+.git
+.github
+Dockerfiles
+docker-compose*.yml
+web/*/node_modules

README.docker.md

@@ -11,7 +11,7 @@ The relevant files are:
 You need to create a local .env file with the following content:
 
 ```
-DELA_NODE_URL=http://127.0.0.1:80               # reverse proxy within backend container
+DELA_NODE_URL=http://172.19.44.254:80           # DELA node
 DATABASE_USERNAME=dvoting                       # choose any PostgreSQL username
 DATABASE_PASSWORD=                              # choose any PostgreSQL password
 DATABASE_HOST=db                                # PostgreSQL host *within the Docker network*
@@ -23,7 +23,7 @@ BACKEND_PORT=5000                               # backend port
 SESSION_SECRET=                                 # choose any secret
 PUBLIC_KEY=                                     # pre-generated key pair
 PRIVATE_KEY=                                    # pre-generated key pair
-PROXYPORT=8080                                  # port of Dela proxy (must be one in DELA_PROXY_PORT_RANGE)
+PROXYPORT=8080                                  # port of DELA proxy
 ```
 
 You can then run
@@ -51,16 +51,15 @@ to delete the volumes (this will reset your instance).
 ## Post-install commands
 
 1. `./init_dela.sh`
-2. `docker compose exec backend /bin/bash`
-3. execute `npx cli addAdmin --sciper 123455` with your SCIPER to add yourself as admin
-5. exit the container and run `docker compose down && docker compose up -d`
+2. run `docker compose exec backend npx cli addAdmin --sciper 123455` with your SCIPER to add yourself as admin
+3. run `docker compose down && docker compose up -d` to restart the containers and load the new permissions
 
 ## Go debugging environment
 
-To use the Go debugging environment, pass the
+To use the Go debugging environment, set the environment variable
 
 ```
---file docker-compose.debug.yml
+COMPOSE_FILE=docker-compose.debug.yml
 ```
 
-flag to all `docker compose` invocations.
+to use this environment in all `docker compose` invocations.

docker-compose.debug.yml

@@ -1,7 +1,7 @@
 services:
 
   dela-worker-0:             # inital DELA leader node
-    image: dela
+    image: dela:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.dela.debug
     environment:
@@ -19,9 +19,9 @@ services:
       - SYS_PTRACE
     networks:
       d-voting:
-        ipv4_address: 172.19.0.255
+        ipv4_address: 172.19.44.254
   dela-worker-1:             # DELA worker node
-    image: dela
+    image: dela:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.dela.debug
     environment:
@@ -39,9 +39,9 @@ services:
       - SYS_PTRACE
     networks:
       d-voting:
-        ipv4_address: 172.19.0.254
+        ipv4_address: 172.19.44.253
   dela-worker-2:             # DELA worker node
-    image: dela
+    image: dela:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.dela.debug
     environment:
@@ -59,10 +59,10 @@ services:
       - SYS_PTRACE
     networks:
       d-voting:
-        ipv4_address: 172.19.0.253
+        ipv4_address: 172.19.44.252
 
   frontend:         # web service frontend
-    image: frontend
+    image: frontend:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.frontend
     ports:
@@ -74,10 +74,10 @@ services:
       BACKEND_PORT: ${BACKEND_PORT}
     networks:
       d-voting:
-        ipv4_address: 172.19.0.2
+        ipv4_address: 172.19.44.2
 
   backend:          # web service backend
-    image: backend
+    image: backend:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.backend
     environment:
@@ -102,7 +102,7 @@ services:
       - ./web/backend/src:/web/backend/src
     networks:
       d-voting:
-        ipv4_address: 172.19.0.3
+        ipv4_address: 172.19.44.3
 
   db:               # PostgreSQL database
     image: postgres:15
@@ -114,7 +114,7 @@ services:
       - ./web/backend/src/migration.sql:/docker-entrypoint-initdb.d/init.sql
     networks:
       d-voting:
-        ipv4_address: 172.19.0.4
+        ipv4_address: 172.19.44.4
 
 volumes:
   postgres-data:    # PostgreSQL database
@@ -127,5 +127,5 @@ networks:
   d-voting:
     ipam:
       config:
-        - subnet: 172.19.0.0/16
-          gateway: 172.19.0.1
+        - subnet: 172.19.44.0/24
+          gateway: 172.19.44.1

docker-compose.yml

@@ -1,7 +1,7 @@
 services:
 
   dela-worker-0:             # inital DELA leader node
-    image: dela
+    image: dela:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.dela
     environment:
@@ -13,9 +13,9 @@ services:
     hostname: dela-worker-0
     networks:
       d-voting:
-        ipv4_address: 172.19.0.255
+        ipv4_address: 172.19.44.254
   dela-worker-1:             # DELA worker node
-    image: dela
+    image: dela:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.dela
     environment:
@@ -27,9 +27,9 @@ services:
     hostname: dela-worker-1
     networks:
       d-voting:
-        ipv4_address: 172.19.0.254
+        ipv4_address: 172.19.44.253
   dela-worker-2:             # DELA worker node
-    image: dela
+    image: dela:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.dela
     environment:
@@ -41,10 +41,10 @@ services:
     hostname: dela-worker-2
     networks:
       d-voting:
-        ipv4_address: 172.19.0.253
+        ipv4_address: 172.19.44.252
 
   frontend:         # web service frontend
-    image: frontend
+    image: frontend:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.frontend
     ports:
@@ -54,10 +54,10 @@ services:
       BACKEND_PORT: ${BACKEND_PORT}
     networks:
       d-voting:
-        ipv4_address: 172.19.0.2
+        ipv4_address: 172.19.44.2
 
   backend:          # web service backend
-    image: backend
+    image: backend:latest
     build:
       dockerfile: ./Dockerfiles/Dockerfile.backend
     environment:
@@ -80,7 +80,7 @@ services:
       - backend-data:/data
     networks:
       d-voting:
-        ipv4_address: 172.19.0.3
+        ipv4_address: 172.19.44.3
 
   db:               # PostgreSQL database
     image: postgres:15
@@ -92,7 +92,7 @@ services:
       - ./web/backend/src/migration.sql:/docker-entrypoint-initdb.d/init.sql
     networks:
       d-voting:
-        ipv4_address: 172.19.0.4
+        ipv4_address: 172.19.44.4
 
 volumes:
   postgres-data:    # PostgreSQL database
@@ -105,5 +105,5 @@ networks:
   d-voting:
     ipam:
       config:
-        - subnet: 172.19.0.0/16
-          gateway: 172.19.0.1
+        - subnet: 172.19.44.0/24
+          gateway: 172.19.44.1