inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-12 10:05:39 +00:00
Code Activity

Documentation for settings file

Browse Source
This commit is contained in:
Oliver Walters
2019-07-10 23:11:41 +10:00
parent f36757c87b
commit b941a4115f
3 changed files with 48 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/start.rst
View File

@ -7,16 +7,16 @@ Getting Started Guide
:caption: Getting Started
:hidden:
To install a complete development environment for InvenTree, follow the steps presented below.
To install a complete *development* environment for InvenTree, follow the steps presented below. A production environment will require further work as per the particular application requirements.
A makefile in the root directory provides shortcuts for the installation process, and can also be very useful during development.
Installation
------------
All packages required to develop and test InvenTree can be installed via pip package manager. Package requirements can be found in ``requirements.txt``.
InvenTree is a Python/Django application and relies on the pip package manager. All packages required to develop and test InvenTree can be installed via pip. Package requirements can be found in ``requirements.txt``.
To setup the InvenTree environment, run the command
To setup the InvenTree environment, run the command:
``make install``
@ -25,6 +25,15 @@ which performs the following actions:
* Installs all required Python packages using pip package manager
* Generates a SECREY_KEY file required for the django authentication framework
Install Configuration
---------------------
InvenTree provides a simple default setup which should work *out of the box* for testing and debug purposes. For installation in production environments, further configuration options are available in the ``config.yaml`` configuration file.
The configuration file provides administrators control over various setup options without digging into the Django ``settings.py`` script. The default setup uses a sqlite database with *DEBUG* mode enabled.
For further information on installation configuration, refer to the `Configuration <config.html>`_ section.
Superuser Account
-----------------