Add deployment docs

ECN · Aug 3, 2021 · c95e283 · c95e283
1 parent 7791923
commit c95e283
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs-src/webqueue2api Package/Deployment.md b/docs-src/webqueue2api Package/Deployment.md
@@ -0,0 +1,18 @@
+For convenience, as WSGI compliant symbole is available at `webqueu2api.api:app`. This can be used with any WSGI server. This project was developed against [gunicorn](https://gunicorn.org/) so that is what we recommend.
+
+!!! example "Development Example"
+    Start a server on `localhost:5000` in debug mode.
+    ```bash
+    gunicorn --log-level debug webqueue2.api:app
+    ```
+
+!!! example "Production Example"
+    Start a public server on port 5000 in the background with access and error logs written to files.
+    ```bash
+    gunicorn --daemon \
+      --access-logfile /var/log/webqueue2api/access.log \ 
+      --error-logfile /var/log/webqueue2api/error.log \ 
+      webqueue2.api:app
+    ```
+
+See [gunicorn's Docs](https://gunicorn.org/#docs) for more details about configuring gunicorn.
diff --git a/docs-src/webqueue2api Package/awesome-pages.yaml b/docs-src/webqueue2api Package/awesome-pages.yaml
@@ -3,5 +3,6 @@
 nav:
     - Getting Started.md
     - Configuration.md
+    - Deployment.md
     - Package Structure.md
     - ...