add description for docker setups

fsinfuhh · Apr 23, 2024 · 71a9cc4 · 71a9cc4
1 parent d954dc6
commit 71a9cc4
Show file tree

Hide file tree

Showing 15 changed files with 20 additions and 8 deletions.
diff --git a/{{ cookiecutter.project_slug }}/Dockerfile b/{{ cookiecutter.project_slug }}/Dockerfile
@@ -22,8 +22,8 @@ FROM docker.io/debian:bookworm as final
 ENV DEBIAN_FRONTEND=noninteractive
 RUN apt-get update &&\
     apt-get install -y --no-install-recommends nodejs python3 python-is-python3 pipenv nginx gunicorn xz-utils supervisor
-COPY docker/supervisord.conf /etc/supervisor/supervisord.conf
-COPY docker/start_backend.sh docker/start_frontend.sh docker/start_nginx.sh /usr/local/bin/
+COPY docker/prod/supervisord.conf /etc/supervisor/supervisord.conf
+COPY docker/prod/start_backend.sh docker/prod/start_frontend.sh docker/prod/start_nginx.sh /usr/local/bin/
 CMD ["/usr/bin/supervisord", "-c", "/etc/supervisor/supervisord.conf"]
 
 # install django server
@@ -32,7 +32,7 @@ ADD Pipfile Pipfile.lock ./
 RUN pipenv install --system --deploy
 ADD LICENSE README.md ./
 ADD src/ ./src/
-ADD docker/nginx.conf /etc/nginx/sites-enabled/default
+ADD docker/prod/nginx.conf /etc/nginx/sites-enabled/default
 
 # add built frontend sources
 COPY --from=gui_build /usr/local/src/{{ cookiecutter.project_slug }}_gui/.output ./src/{{ cookiecutter.project_slug }}_gui/dist/

diff --git a/{{ cookiecutter.project_slug }}/README.md b/{{ cookiecutter.project_slug }}/README.md
@@ -28,3 +28,15 @@ The following variables are defined:
 | `NUXT_PUBLIC_OPENID_ISSUER`       | *mafiasi-identity*                |    no     | The openid issuer which the frontend uses for authentication (should be the same as the one in configured for django) |
 
 For the configuration of these variables in `dev` mode, see the configuration in [.env.dev](./.env.dev).
+
+## Docker Setup
+
+This project contains two different docker setup. One is for production, one for development.
+
+### Production Setup
+
+The Docker Setup for production consists of the `Dockerfile` in the root of this project. The required assets are in the `/docker/prod` directory.
+
+### Development Setup
+
+The Docker Setup for development is based on the `compose.yaml` in the root of this project. All Dockerfiles and other files required for this are in the `/docker/dev` directory.
diff --git a/{{ cookiecutter.project_slug }}/compose.yaml b/{{ cookiecutter.project_slug }}/compose.yaml
@@ -11,19 +11,19 @@ services:
   backend:
     build:
       context: ./
-      dockerfile: ./docker/backend/Dockerfile
+      dockerfile: ./docker/dev/backend/Dockerfile
     volumes:
       - ./:/app/backend
     depends_on:
       - database
 
   frontend:
-    build: docker/frontend
+    build: docker/dev/frontend
     volumes:
       - ./src/{{ cookiecutter.project_slug }}_gui:/app/frontend
 
   webserver:
-    build: docker/webserver
+    build: docker/dev/webserver
     depends_on:
       - backend
       - frontend

diff --git a/...project_slug }}/docker/backend/Dockerfile → ...ect_slug }}/docker/dev/backend/Dockerfile b/...project_slug }}/docker/backend/Dockerfile → ...ect_slug }}/docker/dev/backend/Dockerfile
@@ -12,10 +12,10 @@ RUN pip3 install pipenv==v2022.4.20
 
 RUN usermod -u 2009 -g 33 -d /app/backend www-data
 
-ADD ./docker/backend/env.dev.local /app/config/.env.dev.local
+ADD ./docker/dev/backend/env.dev.local /app/config/.env.dev.local
 
 EXPOSE 8000
 
 #USER www-data:www-data
-ADD ./docker/backend/start.sh /usr/local/bin/start.sh
+ADD ./docker/dev/backend/start.sh /usr/local/bin/start.sh
 CMD ["bash", "/usr/local/bin/start.sh"]
diff --git a/...ject_slug }}/docker/backend/env.dev.local → ..._slug }}/docker/dev/backend/env.dev.local b/...ject_slug }}/docker/backend/env.dev.local → ..._slug }}/docker/dev/backend/env.dev.local
diff --git a/...r.project_slug }}/docker/backend/start.sh → ...oject_slug }}/docker/dev/backend/start.sh b/...r.project_slug }}/docker/backend/start.sh → ...oject_slug }}/docker/dev/backend/start.sh
diff --git a/...roject_slug }}/docker/frontend/Dockerfile → ...ct_slug }}/docker/dev/frontend/Dockerfile b/...roject_slug }}/docker/frontend/Dockerfile → ...ct_slug }}/docker/dev/frontend/Dockerfile
diff --git a/....project_slug }}/docker/frontend/start.sh → ...ject_slug }}/docker/dev/frontend/start.sh b/....project_slug }}/docker/frontend/start.sh → ...ject_slug }}/docker/dev/frontend/start.sh
diff --git a/...oject_slug }}/docker/webserver/Dockerfile → ...t_slug }}/docker/dev/webserver/Dockerfile b/...oject_slug }}/docker/webserver/Dockerfile → ...t_slug }}/docker/dev/webserver/Dockerfile
diff --git a/...oject_slug }}/docker/webserver/nginx.conf → ...t_slug }}/docker/dev/webserver/nginx.conf b/...oject_slug }}/docker/webserver/nginx.conf → ...t_slug }}/docker/dev/webserver/nginx.conf
diff --git a/...ecutter.project_slug }}/docker/nginx.conf → ...er.project_slug }}/docker/prod/nginx.conf b/...ecutter.project_slug }}/docker/nginx.conf → ...er.project_slug }}/docker/prod/nginx.conf
diff --git a/...r.project_slug }}/docker/start_backend.sh → ...ject_slug }}/docker/prod/start_backend.sh b/...r.project_slug }}/docker/start_backend.sh → ...ject_slug }}/docker/prod/start_backend.sh
diff --git a/....project_slug }}/docker/start_frontend.sh → ...ect_slug }}/docker/prod/start_frontend.sh b/....project_slug }}/docker/start_frontend.sh → ...ect_slug }}/docker/prod/start_frontend.sh
diff --git a/...ter.project_slug }}/docker/start_nginx.sh → ...roject_slug }}/docker/prod/start_nginx.sh b/...ter.project_slug }}/docker/start_nginx.sh → ...roject_slug }}/docker/prod/start_nginx.sh
diff --git a/...r.project_slug }}/docker/supervisord.conf → ...ject_slug }}/docker/prod/supervisord.conf b/...r.project_slug }}/docker/supervisord.conf → ...ject_slug }}/docker/prod/supervisord.conf