diff --git a/docs-src/webqueue2api Package/Deployment.md b/docs-src/webqueue2api Package/Deployment.md new file mode 100644 index 0000000..c43a0e9 --- /dev/null +++ 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. \ No newline at end of file diff --git a/docs-src/webqueue2api Package/awesome-pages.yaml b/docs-src/webqueue2api Package/awesome-pages.yaml index 9c82ab4..aec8315 100644 --- 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 - ... \ No newline at end of file