docs(deploy): add ASGI Uvicorn + NGINX deployment guide (#1784) - #2708
docs(deploy): add ASGI Uvicorn + NGINX deployment guide (#1784)#2708zarinpy wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2708 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 64 64
Lines 7990 7990
Branches 1106 1106
=========================================
Hits 7990 7990 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vytas7
left a comment
There was a problem hiding this comment.
Thanks @zarinpy , and sorry for the somewhat delayed review.
This looks really good and thought through overall. 💯
Although not critical or detracting value from your contribution, but ideally I would like to find a way to reduce the amount of copy-paste vs nginx-uwsgi.rst, especially the "Running your Application as a Different User" section seems to be a carbon copy.
Maybe we could restructure these docs to share the introductory parts, or, if copy-pasting is the desired outcome, maybe we could factor these snippets into separate files, and use "literalinclude"? 🤔
thanks a lot for reviewing my commitment, I will definitely spend good time to make a good change to the docs and push. |
Summary of Changes
Add a production-oriented deployment guide for ASGI Falcon apps with Uvicorn
behind NGINX, parallel to the existing NGINX + uWSGI WSGI guide.
docs/deploy/uvicorn-nginx.rst(separate OS users, venv,asgi:app, Uvicorn workers/proxy headers, optional systemd unit,NGINX reverse proxy with TLS and WebSocket upgrade headers)
Related Issues
Closes #1784
Pull Request Checklist
This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. Reading our contribution guide at least once will save you a few review cycles!
If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.
tox.docs/.docs/.versionadded,versionchanged, ordeprecateddirectives.docs/_newsfragments/, with the file name format{issue_number}.{fragment_type}.rst. (Runtox -e docs, and inspectdocs/_build/html/changes/in the browser to ensure it renders correctly.)If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!
PR template inspired by the attrs project.