mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
Add simple deployment documentation
This commit is contained in:
parent
d0e1dc52f8
commit
04efa2ece8
52
docs/deploy.rst
Normal file
52
docs/deploy.rst
Normal file
@ -0,0 +1,52 @@
|
||||
Deploying InvenTree
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:maxdepth: 2
|
||||
:caption: Deployment
|
||||
:hidden:
|
||||
|
||||
The development server provided by the Django ecosystem may be fine for a testing environment or small contained setups. However special consideration must be given when deploying InvenTree in a real-world environment.
|
||||
|
||||
Django apps provide multiple deployment methods - see the `Django documentation <https://docs.djangoproject.com/en/2.2/howto/deployment/>`_.
|
||||
|
||||
There are also numerous online tutorials describing how to deploy a Django application either locally or on an online platform.
|
||||
|
||||
Following is a simple tutorial on serving InvenTree using `Gunicorn <https://gunicorn.org/>`_. Gunicorn is a Python WSGI server which provides a multi-worker server which is much better suited to handling multiple simultaneous requests.
|
||||
|
||||
Install Gunicorn
|
||||
----------------
|
||||
|
||||
Gunicorn can be installed using PIP:
|
||||
|
||||
`pip3 install gunicorn`
|
||||
|
||||
|
||||
Configure Static Directories
|
||||
----------------------------
|
||||
|
||||
Directories for storing *media* files and *static* files should be specified in the ``config.yaml`` configuration file. These directories are the ``MEDIA_ROOT`` and ``STATIC_ROOT`` paths required by the Django app.
|
||||
|
||||
Collect Static Files
|
||||
--------------------
|
||||
|
||||
The required static files must be collected into the specified ``STATIC_ROOT`` directory. Run ``python3 manage.py collectstatic``
|
||||
|
||||
Configure Gunicorn
|
||||
------------------
|
||||
|
||||
The Gunicorn server can be configured with a simple configuration file (e.g. python script). An example configuration file is provided in ``InvenTree/gunicorn.conf.py``
|
||||
|
||||
.. literalinclude :: ../InvenTree/gunicorn.conf.py
|
||||
:language: python
|
||||
:linenos:
|
||||
|
||||
This file can be used to configure the Gunicorn server to match particular requirements.
|
||||
|
||||
Run Gunicorn
|
||||
------------
|
||||
|
||||
From the directory where ``manage.py`` is located:
|
||||
|
||||
Run ``gunicorn -c gunicorn.conf.py InvenTree.wsgi``
|
@ -9,6 +9,7 @@ InvenTree Source Documentation
|
||||
|
||||
Getting Started<start>
|
||||
Configuration<config>
|
||||
Deployment<deploy>
|
||||
Modal Forms<forms>
|
||||
Tables<tables>
|
||||
REST API<rest>
|
||||
|
Loading…
Reference in New Issue
Block a user