feat(docker): replace uwsgi with gunicorn as app server

.mypy.ini

@@ -37,9 +37,6 @@ ignore_missing_imports = True
 [mypy-environ.*]
 ignore_missing_imports = True
 
-[mypy-uwsgi.*]
-ignore_missing_imports = True
-
 [mypy-xltpl.*]
 ignore_missing_imports = True
 

Dockerfile

@@ -6,7 +6,6 @@ ENV HOME=/home/document-merge-service
 ENV PYTHONUNBUFFERED=1
 ENV DJANGO_SETTINGS_MODULE=document_merge_service.settings
 ENV APP_HOME=/app
-ENV UWSGI_INI=/app/uwsgi.ini
 ENV MEDIA_ROOT=/var/lib/document-merge-service/media
 ENV DATABASE_DIR=/var/lib/document-merge-service/data
 
@@ -47,4 +46,4 @@ COPY . $APP_HOME
 
 EXPOSE 8000
 
-CMD /bin/sh -c "poetry run python ./manage.py migrate && poetry run uwsgi"
+CMD /bin/sh -c "poetry run python ./manage.py migrate && poetry run gunicorn -c ./document_merge_service/gunicorn.py"

README.md

@@ -36,6 +36,29 @@ environment:
   - ISOLATE_UNOCONV=true
 ```
 
+### Custom Gunicorn configuration
+
+Document Merge Service uses [Gunicorn](https://gunicorn.org/) as its app server. A reasonable configuration is included in the docker image. However, if you want to customize your configuration, you may do that by overwriting the file [`document_merge_service/gunicorn.py`](document_merge_service/gunicorn.py) and add your own custom settings:
+
+```dockerfile
+FROM ghcr.io/adfinis/document-merge-service:latest
+
+COPY my_gunicorn_config.py /app/document_merge_service/gunicorn.py
+```
+
+Such a configuration file might look like this:
+
+```python
+# my_gunicorn_config.py
+
+wsgi_app = "document_merge_service.wsgi:application" # must not be changed
+bind = "0.0.0.0:80"
+workers = 16
+timeout = 120
+```
+
+For more information on how to customize Gunicorn, please refer to [the official documentation](https://docs.gunicorn.org/en/latest/settings.html).
+
 ## Getting started
 
 ### Uploading templates
@@ -55,13 +78,13 @@ curl -H "Content-Type: application/json" --data '{"data": {"test": "Test Input"}
 ```
 
 ### Converting a template
+
 To convert a standalone Docx file the following call can be used:
 
 ```bash
 curl -X POST --form [email protected] --form target_format="pdf" http://localhost:8000/api/v1/convert > example.pdf
 ```
 
-
 ## Further reading
 
 - [Configuration](CONFIGURATION.md) - Further configuration and how to do a production setup

docker-compose.override.yml

@@ -1,4 +1,3 @@
-version: "3.4"
 services:
   document-merge-service:
     image: ghcr.io/adfinis/document-merge-service:dev

docker-compose.yml

@@ -1,4 +1,3 @@
-version: "3.4"
 services:
   document-merge-service:
     image: ghcr.io/adfinis/document-merge-service:latest

document_merge_service/api/unoconv.py

@@ -35,16 +35,18 @@
 
 def get_default_timeout():
     timeout = 55
-    try:  # pragma: no cover
-        import uwsgi
+    try:
+        from document_merge_service import gunicorn
 
-        harakiri = uwsgi.opt.get("harakiri")
+        # Default is 30s if not configured explicitly:
+        # https://docs.gunicorn.org/en/latest/settings.html#timeout
+        harakiri = getattr(gunicorn, "timeout", 30)
         if harakiri:
             try:
                 timeout = max(int(harakiri) - _ahead_of_harakiri, _min_timeout)
-            except ValueError:
+            except ValueError:  # pragma: no cover
                 pass
-    except ModuleNotFoundError:
+    except ModuleNotFoundError:  # pragma: no cover
         pass
     return timeout
 

document_merge_service/gunicorn.py

@@ -0,0 +1,5 @@
+wsgi_app = "document_merge_service.wsgi:application"
+bind = "0.0.0.0:8000"
+workers = 8
+proc_name = "dms"
+timeout = 60

document_merge_service/settings.py

@@ -66,6 +66,7 @@ def default(default_dev=env.NOTSET, default_prod=env.NOTSET):
     "corsheaders.middleware.CorsMiddleware",
     "django.middleware.common.CommonMiddleware",
     "django.middleware.locale.LocaleMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
 ]
 
 ROOT_URLCONF = "document_merge_service.urls"
@@ -141,9 +142,8 @@ def parse_admins(admins):
 
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/1.11/howto/static-files/
-
 STATIC_URL = "/static/"
-STATIC_ROOT = env.str("STATIC_ROOT", None)
+STATIC_ROOT = os.path.join(django_root, "staticfiles")
 
 # Media files
 
@@ -154,7 +154,7 @@ def parse_admins(admins):
         )
     },
     "staticfiles": {
-        "BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage",
+        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
     },
 }
 MEDIA_ROOT = env.str("MEDIA_ROOT", "")

pyproject.toml

@@ -38,6 +38,7 @@ django-storages = "^1.14.3"
 djangorestframework = "^3.15.1"
 docx-mailmerge = "^0.5.0"
 docxtpl = "^0.17.0"
+gunicorn = "^22.0.0"
 Jinja2 = "^3.1.4"
 mysqlclient = { version = "^2.2.4", optional = true }
 pillow = "^10.3.0"
@@ -48,7 +49,7 @@ python-memcached = "^1.59"
 requests = "^2.32.3"
 sentry-sdk = "^2.3.1"
 urllib3 = "^2.2.1"
-uWSGI = "^2.0.21"
+whitenoise = "^6.6.0"
 xltpl = "~0.19"
 
 [tool.poetry.group.dev.dependencies]