inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-27 21:26:43 +00:00
Code

Update docs for production image

Browse Source
This commit is contained in:
Oliver Walters 2022-05-29 00:47:04 +10:00
parent e73db9d284
commit b83aed9a8a
2 changed files with 37 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/start/config.md
View File

@ -48,6 +48,16 @@ The following basic options are available:
| INVENTREE_LOG_LEVEL | log_level | Set level of logging to terminal | WARNING |
| INVENTREE_PLUGINS_ENABLED | plugins_enabled | Enable plugin support | False |
## Administrator Account
An administrator account can be specified using the following environment variables:
| Environment Variable | Settings File | Description | Default |
| --- | --- | --- | --- |
| INVENTREE_ADMIN_USER | admin_user | Admin account username | *Not set* |
| INVENTREE_ADMIN_PASSWORD | admin_password | Admin account password | *Not set* |
| INVENTREE_ADMIN_EMAIL | admin_email |Admin account email address | *Not set* |
## Secret Key
InvenTree requires a secret key for providing cryptographic signing - this should be a secret (and unpredictable) value.

52
docs/start/docker_prod.md
View File

@ -4,15 +4,17 @@ title: Docker Production Server
## Docker Production Server
Using the [InvenTree docker image](./docker.md) streamlines the setup process for an InvenTree production server.
Using the [InvenTree docker image](./docker.md) simplifies the setup process for an InvenTree production server.
The following guide provides a streamlined production InvenTree installation, with minimal configuration required.
!!! info "Starting Point"
This setup guide should be considered a *starting point*. It is likely that your particular production requirements will vary from the example shown here.
### Before You Start
#### Docker Compose
This guide assumes that you are comfortable with the basic concepts of docker and docker-compose.
!!! warning "Docker Skills Required"
This guide assumes that you are reasonably comfortable with the basic concepts of docker and docker-compose.
#### Docker Image
@ -20,15 +22,17 @@ This production setup guide uses the official InvenTree docker image, available
#### Static and Media Files
The sample docker-compose configuration shown on this page uses nginx to serve static files and media files. If you change this configuration, you will need to ensure that static and media files are served correctly. When running with `debug=False`, django *will not serve these files* - see the [django documentation](https://docs.djangoproject.com/en/dev/howto/static-files/).
The sample docker-compose configuration outlined on this page uses nginx to serve static files and media files. If you change this configuration, you will need to ensure that static and media files are served correctly. When running with `debug=False`, django *will not serve these files* - see the [django documentation](https://docs.djangoproject.com/en/dev/howto/static-files/).
#### Required Files
The files required for this setup are provided with the InvenTree source, located in the `./docker/production` directory:
- **docker-compose.yml** : The docker compose script
- **.env** : Environment variables
- **nginx.prod.conf** : nginx proxy configuration file
| Filename | Description |
| --- | --- |
| docker-compose.yml | The docker compose script |
| .env | Environment variables |
| nginx.prod.conf | nginx proxy configuration file |
This tutorial assumes you are working from the `./docker/production` directory. If this is not the case, ensure that these files are provided in your working directory.
@ -63,16 +67,13 @@ This container uses the official [nginx image](https://hub.docker.com/_/nginx).
### Data Volume
InvenTree stores data which is meant to be persistent (e.g. uploaded media files, database data, etc) in a volume which is mapped to a local system directory. The location of this directory must be configured in the `.env` file.
InvenTree stores any persistent data (e.g. uploaded media files, database data, etc) in a [volume](https://docs.docker.com/storage/volumes/) which is mapped to a local system directory. The location of this directory must be configured in the `.env` file, specified using the `INVENTREE_EXT_VOLUME` variable.
!!! info "Data Directory"
Make sure you change the path to the local directory where you want persistent data to be stored.
## Production Setup Guide
!!! info "Starting Point"
This setup guide assumes you are starting in the `./docker/production/` directory.
### Edit Environment Variables
The first step is to edit the environment variables, located in the `.env` file.
@ -83,19 +84,10 @@ The first step is to edit the environment variables, located in the `.env` file.
!!! warning "Database Credentials"
You must also define the database username (`INVENTREE_DB_USER`) and password (`INVENTREE_DB_PASSWORD`). You should ensure they are changed from the default values for added security
### Create Database
Launch the postgresql database container, and create an empty database, with the following command:
### Initial Database Setup
```bash
docker-compose run -d inventree-db
```
This will start the `inventree_db` container (in the background) and create an empty database.
### Perform Database Setup
The database has now been created, but it is empty! Perform the initial database setup by running the following command:
Perform the initial database setup by running the following command:
```bash
docker-compose run inventree-server invoke update
@ -104,11 +96,12 @@ docker-compose run inventree-server invoke update
This command performs the following steps:
- Ensure required python packages are installed
- Create a new (empty) database
- Perform the required schema updates to create the required database tables
- Update translation files
- Collect all required static files into a directory where they can be served by nginx
### Create Admin Account
### Create Administrator Account
If you are creating the initial database, you need to create an admin (superuser) account for the database. Run the command below, and follow the prompts:
@ -116,6 +109,14 @@ If you are creating the initial database, you need to create an admin (superuser
docker-compose run inventree-server invoke superuser
```
Alternatively, admin account details can be specifed in the `.env` file, removing the need for this manual step:
| Variable | Description |
| --- | --- |
| INVENTREE_ADMIN_USER | Admin account username |
| INVENTREE_ADMIN_PASSWORD | Admin account password |
| INVENTREE_ADMIN_EMAIL | Admin account email address |
### Start Docker Containers
Now that the database has been created, migrations applied, and you have created an admin account, we are ready to launch the InvenTree containers:
@ -124,8 +125,9 @@ Now that the database has been created, migrations applied, and you have created
docker-compose up -d
```
This command launches the remaining containers:
This command launches the following containers:
- `inventree-db` - PostgreSQL database
- `inventree-server` - InvenTree web server
- `inventree-worker` - Background worker
- `inventree-nginx` - Nginx reverse proxy