Docs: Fix pre-commit formatting issues
This commit is contained in:
parent
66b3945f66
commit
068366b0e9
3 changed files with 22 additions and 22 deletions
|
|
@ -74,8 +74,8 @@ errors are shown. To show access logs on stdout, use the
|
||||||
Configuration File
|
Configuration File
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
While passing arguments to Gunicorn via the command line is useful for simple
|
While passing arguments to Gunicorn via the command line is useful for simple
|
||||||
setups, production deployments usually rely on a configuration file.
|
setups, production deployments usually rely on a configuration file.
|
||||||
|
|
||||||
Create a file named ``gunicorn.conf.py`` in your project directory:
|
Create a file named ``gunicorn.conf.py`` in your project directory:
|
||||||
|
|
||||||
|
|
@ -86,7 +86,7 @@ Create a file named ``gunicorn.conf.py`` in your project directory:
|
||||||
workers = 4
|
workers = 4
|
||||||
accesslog = "-"
|
accesslog = "-"
|
||||||
|
|
||||||
You can then run Gunicorn by pointing it to your configuration file using
|
You can then run Gunicorn by pointing it to your configuration file using
|
||||||
the ``-c`` option:
|
the ``-c`` option:
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
@ -97,12 +97,12 @@ the ``-c`` option:
|
||||||
Running in the Background
|
Running in the Background
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
Running Gunicorn from the command line blocks the terminal. For production
|
Running Gunicorn from the command line blocks the terminal. For production
|
||||||
deployments, you should use a process manager like ``systemd`` or ``supervisor``
|
deployments, you should use a process manager like ``systemd`` or ``supervisor``
|
||||||
to run Gunicorn in the background, start it automatically on boot and restart
|
to run Gunicorn in the background, start it automatically on boot and restart
|
||||||
it if it crashes.
|
it if it crashes.
|
||||||
|
|
||||||
See the Gunicorn documentation on `Deploying Gunicorn <https://docs.gunicorn.org/en/latest/deploy.html>`_
|
See the Gunicorn documentation on `Deploying Gunicorn <https://docs.gunicorn.org/en/latest/deploy.html>`_
|
||||||
for examples of systemd service files.
|
for examples of systemd service files.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -128,10 +128,10 @@ otherwise it will be possible to bypass the proxy.
|
||||||
IP address in your browser.
|
IP address in your browser.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
When running Gunicorn behind a reverse proxy, the proxy will intercept the
|
When running Gunicorn behind a reverse proxy, the proxy will intercept the
|
||||||
client's IP address. To ensure your Flask application correctly reads the
|
client's IP address. To ensure your Flask application correctly reads the
|
||||||
forwarded headers (like ``X-Forwarded-For``), you must apply the
|
forwarded headers (like ``X-Forwarded-For``), you must apply the
|
||||||
:class:`~werkzeug.middleware.proxy_fix.ProxyFix` middleware. See
|
:class:`~werkzeug.middleware.proxy_fix.ProxyFix` middleware. See
|
||||||
:doc:`proxy_fix` for more information.
|
:doc:`proxy_fix` for more information.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -155,4 +155,4 @@ required.
|
||||||
Starting gunicorn 20.1.0
|
Starting gunicorn 20.1.0
|
||||||
Listening at: http://127.0.0.1:8000 (x)
|
Listening at: http://127.0.0.1:8000 (x)
|
||||||
Using worker: gevent
|
Using worker: gevent
|
||||||
Booting worker with pid: x
|
Booting worker with pid: x
|
||||||
|
|
|
||||||
|
|
@ -208,10 +208,10 @@ previous page.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
The ``init-db`` command will run the ``schema.sql`` file, which starts by
|
The ``init-db`` command will run the ``schema.sql`` file, which starts by
|
||||||
dropping the existing ``user`` and ``post`` tables. **Running this command
|
dropping the existing ``user`` and ``post`` tables. **Running this command
|
||||||
will permanently delete any existing data in your database.** Only run it
|
will permanently delete any existing data in your database.** Only run it
|
||||||
when you are setting up the project for the first time or if you intentionally
|
when you are setting up the project for the first time or if you intentionally
|
||||||
want to start over with an empty database.
|
want to start over with an empty database.
|
||||||
|
|
||||||
Run the ``init-db`` command:
|
Run the ``init-db`` command:
|
||||||
|
|
@ -224,4 +224,4 @@ Run the ``init-db`` command:
|
||||||
There will now be a ``flaskr.sqlite`` file in the ``instance`` folder in
|
There will now be a ``flaskr.sqlite`` file in the ``instance`` folder in
|
||||||
your project.
|
your project.
|
||||||
|
|
||||||
Continue to :doc:`views`.
|
Continue to :doc:`views`.
|
||||||
|
|
|
||||||
|
|
@ -73,9 +73,9 @@ will read from if it exists. Copy the generated value into it.
|
||||||
SECRET_KEY = '192b9bdd22ab9ed4d12e236c78afcb9a393ec15f71bbf5dc987d54727823bcbf'
|
SECRET_KEY = '192b9bdd22ab9ed4d12e236c78afcb9a393ec15f71bbf5dc987d54727823bcbf'
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
Never commit the file containing your production ``SECRET_KEY`` to version
|
Never commit the file containing your production ``SECRET_KEY`` to version
|
||||||
control. Ensure that your ``.gitignore`` file excludes the ``instance/``
|
control. Ensure that your ``.gitignore`` file excludes the ``instance/``
|
||||||
folder and the specific ``config.py`` file to prevent leaking your secret
|
folder and the specific ``config.py`` file to prevent leaking your secret
|
||||||
key to a public repository.
|
key to a public repository.
|
||||||
|
|
||||||
You can also set any other necessary configuration here, although
|
You can also set any other necessary configuration here, although
|
||||||
|
|
@ -114,4 +114,4 @@ servers and deployment options that you may choose for your project.
|
||||||
|
|
||||||
.. _Waitress: https://docs.pylonsproject.org/projects/waitress/en/stable/
|
.. _Waitress: https://docs.pylonsproject.org/projects/waitress/en/stable/
|
||||||
|
|
||||||
Continue to :doc:`next`.
|
Continue to :doc:`next`.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue