mirror of
https://github.com/django/django.git
synced 2025-10-23 21:59:11 +00:00
[4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples.
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for
reviews.
Backport of 534ac48297 from main.
This commit is contained in:
committed by
Mariusz Felisiak
parent
4a89aa25c9
commit
b784768eef
@@ -2,8 +2,6 @@
|
||||
How to use Django with Daphne
|
||||
=============================
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
Daphne_ is a pure-Python ASGI server for UNIX, maintained by members of the
|
||||
Django project. It acts as the reference server for ASGI.
|
||||
|
||||
@@ -12,7 +10,9 @@ Django project. It acts as the reference server for ASGI.
|
||||
Installing Daphne
|
||||
===================
|
||||
|
||||
You can install Daphne with ``pip``::
|
||||
You can install Daphne with ``pip``:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
python -m pip install daphne
|
||||
|
||||
@@ -24,7 +24,9 @@ Daphne server process. At its simplest, Daphne needs to be called with the
|
||||
location of a module containing an ASGI application object, followed by what
|
||||
the application is called (separated by a colon).
|
||||
|
||||
For a typical Django project, invoking Daphne would look like::
|
||||
For a typical Django project, invoking Daphne would look like:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
daphne myproject.asgi:application
|
||||
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
How to use Django with Hypercorn
|
||||
================================
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
Hypercorn_ is an ASGI server that supports HTTP/1, HTTP/2, and HTTP/3
|
||||
with an emphasis on protocol support.
|
||||
|
||||
Installing Hypercorn
|
||||
====================
|
||||
|
||||
You can install Hypercorn with ``pip``::
|
||||
You can install Hypercorn with ``pip``:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
python -m pip install hypercorn
|
||||
|
||||
@@ -22,7 +22,9 @@ which runs ASGI applications. Hypercorn needs to be called with the
|
||||
location of a module containing an ASGI application object, followed
|
||||
by what the application is called (separated by a colon).
|
||||
|
||||
For a typical Django project, invoking Hypercorn would look like::
|
||||
For a typical Django project, invoking Hypercorn would look like:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
hypercorn myproject.asgi:application
|
||||
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
How to use Django with Uvicorn
|
||||
==============================
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
Uvicorn_ is an ASGI server based on ``uvloop`` and ``httptools``, with an
|
||||
emphasis on speed.
|
||||
|
||||
Installing Uvicorn
|
||||
==================
|
||||
|
||||
You can install Uvicorn with ``pip``::
|
||||
You can install Uvicorn with ``pip``:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
python -m pip install uvicorn
|
||||
|
||||
@@ -22,7 +22,9 @@ applications. Uvicorn needs to be called with the location of a module
|
||||
containing an ASGI application object, followed by what the application is
|
||||
called (separated by a colon).
|
||||
|
||||
For a typical Django project, invoking Uvicorn would look like::
|
||||
For a typical Django project, invoking Uvicorn would look like:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
python -m uvicorn myproject.asgi:application
|
||||
|
||||
@@ -41,11 +43,15 @@ Deploying Django using Uvicorn and Gunicorn
|
||||
Gunicorn_ is a robust web server that implements process monitoring and automatic
|
||||
restarts. This can be useful when running Uvicorn in a production environment.
|
||||
|
||||
To install Uvicorn and Gunicorn, use the following::
|
||||
To install Uvicorn and Gunicorn, use the following:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
python -m pip install uvicorn gunicorn
|
||||
|
||||
Then start Gunicorn using the Uvicorn worker class like this::
|
||||
Then start Gunicorn using the Uvicorn worker class like this:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
python -m gunicorn myproject.asgi:application -k uvicorn.workers.UvicornWorker
|
||||
|
||||
|
||||
@@ -2,8 +2,6 @@
|
||||
How to use Django with Gunicorn
|
||||
===============================
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
Gunicorn_ ('Green Unicorn') is a pure-Python WSGI server for UNIX. It has no
|
||||
dependencies and can be installed using ``pip``.
|
||||
|
||||
@@ -23,7 +21,9 @@ Running Django in Gunicorn as a generic WSGI application
|
||||
When Gunicorn is installed, a ``gunicorn`` command is available which starts
|
||||
the Gunicorn server process. The simplest invocation of gunicorn is to pass the
|
||||
location of a module containing a WSGI application object named
|
||||
``application``, which for a typical Django project would look like::
|
||||
``application``, which for a typical Django project would look like:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
gunicorn myproject.wsgi
|
||||
|
||||
|
||||
@@ -85,7 +85,9 @@ should put in this file, and what else you can add to it.
|
||||
|
||||
If you get a ``UnicodeEncodeError`` when uploading or writing files with
|
||||
file names or content that contains non-ASCII characters, make sure Apache
|
||||
is configured to support UTF-8 encoding::
|
||||
is configured to support UTF-8 encoding:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
export LANG='en_US.UTF-8'
|
||||
export LC_ALL='en_US.UTF-8'
|
||||
@@ -94,7 +96,9 @@ should put in this file, and what else you can add to it.
|
||||
|
||||
Alternatively, if you are :ref:`using mod_wsgi daemon mode<daemon-mode>`
|
||||
you can add ``lang`` and ``locale`` options to the ``WSGIDaemonProcess``
|
||||
directive::
|
||||
directive:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
WSGIDaemonProcess example.com lang='en_US.UTF-8' locale='en_US.UTF-8'
|
||||
|
||||
|
||||
@@ -2,8 +2,6 @@
|
||||
How to use Django with uWSGI
|
||||
============================
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
uWSGI_ is a fast, self-healing and developer/sysadmin-friendly application
|
||||
container server coded in pure C.
|
||||
|
||||
@@ -48,7 +46,9 @@ uWSGI supports multiple ways to configure the process. See uWSGI's
|
||||
|
||||
.. _configuration documentation: https://uwsgi.readthedocs.io/en/latest/Configuration.html
|
||||
|
||||
Here's an example command to start a uWSGI server::
|
||||
Here's an example command to start a uWSGI server:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
uwsgi --chdir=/path/to/your/project \
|
||||
--module=mysite.wsgi:application \
|
||||
@@ -80,7 +80,9 @@ The Django-specific options here are:
|
||||
* ``env``: Should probably contain at least :envvar:`DJANGO_SETTINGS_MODULE`.
|
||||
* ``home``: Optional path to your project virtual environment.
|
||||
|
||||
Example ini configuration file::
|
||||
Example ini configuration file:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[uwsgi]
|
||||
chdir=/path/to/your/project
|
||||
@@ -91,7 +93,9 @@ Example ini configuration file::
|
||||
max-requests=5000
|
||||
daemonize=/var/log/uwsgi/yourproject.log
|
||||
|
||||
Example ini configuration file usage::
|
||||
Example ini configuration file usage:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
uwsgi --ini uwsgi.ini
|
||||
|
||||
@@ -99,7 +103,9 @@ Example ini configuration file usage::
|
||||
|
||||
If you get a ``UnicodeEncodeError`` when uploading files with file names
|
||||
that contain non-ASCII characters, make sure uWSGI is configured to accept
|
||||
non-ASCII file names by adding this to your ``uwsgi.ini``::
|
||||
non-ASCII file names by adding this to your ``uwsgi.ini``:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
env = LANG=en_US.UTF-8
|
||||
|
||||
|
||||
Reference in New Issue
Block a user