mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-06-12 18:25:27 +00:00
Fixing pretty much every existing internal link.
Sometimes, it pays to RTFD
This commit is contained in:
@ -84,7 +84,7 @@ The following database options can be configured:
|
||||
|
||||
## Email Settings
|
||||
|
||||
To enable [email functionality](../../admin/email), email settings must be configured here, either via environment variables or within the configuration file.
|
||||
To enable [email functionality](../admin/email.md), email settings must be configured here, either via environment variables or within the configuration file.
|
||||
|
||||
The following email settings are available:
|
||||
|
||||
|
@ -5,12 +5,12 @@ title: Development Server
|
||||
## Development Server
|
||||
|
||||
!!! warning "Installation"
|
||||
Before continuing, ensure that the [installation steps](../install) have been completed.
|
||||
Before continuing, ensure that the [installation steps](./install.md) have been completed.
|
||||
|
||||
InvenTree includes a simple server application, suitable for use in a development environment.
|
||||
|
||||
!!! warning "Deployment"
|
||||
Refer to the [production server instructions](../production) to implement a much more robust server setup.
|
||||
Refer to the [production server instructions](./production.md) to implement a much more robust server setup.
|
||||
|
||||
### Running on a Local Machine
|
||||
|
||||
|
@ -10,7 +10,7 @@ The InvenTree docker image contains all the required system packages, python mod
|
||||
|
||||
### Environment Variables
|
||||
|
||||
InvenTree run-time configuration options described in the [configuration documentation](../config) can be passed to the InvenTree container as environment variables.
|
||||
InvenTree run-time configuration options described in the [configuration documentation](./config.md) can be passed to the InvenTree container as environment variables.
|
||||
|
||||
The following environment variables for InvenTree server configuration are specified as part of the docker image, and can be overridden if required:
|
||||
|
||||
@ -46,7 +46,7 @@ Static files are stored internal to the container instance, at the location `/ho
|
||||
|
||||
### Configuration File
|
||||
|
||||
As discussed in the [configuration documentation](../config), InvenTree run-time settings can be provided in a configuration file.
|
||||
As discussed in the [configuration documentation](./config.md), InvenTree run-time settings can be provided in a configuration file.
|
||||
|
||||
By default, the docker container expects this configuration file in the location `/home/inventree/data/config.yaml`. If this file does not exist, it will be automatically created from a default template file.
|
||||
|
||||
@ -56,7 +56,7 @@ As this config file is inside the "data" directory (which should be mounted as a
|
||||
|
||||
InvenTree uses a secret key to provide cryptographic signing for the application.
|
||||
|
||||
As specified in the [configuration documentation](../config/#secret-key) this can be passed to the InvenTree application directly as an environment variable, or provided via a file.
|
||||
As specified in the [configuration documentation](./config.md#secret-key) this can be passed to the InvenTree application directly as an environment variable, or provided via a file.
|
||||
|
||||
By default, the InvenTree container expects the `INVENTREE_SECRET_KEY_FILE` to exist at `/home/inventree/data/secret_key.txt`. If this file does not exist, it will be created and a new key will be randomly generated.
|
||||
|
||||
@ -223,7 +223,7 @@ Alter (or add) environment variables into the docker-compose `environment` secti
|
||||
|
||||
A configuration file `config.yaml` has been created in the data volume (at the location specified on your local disk).
|
||||
|
||||
Edit this file (as per the [configuration guidelines](../config)).
|
||||
Edit this file (as per the [configuration guidelines](./config.md)).
|
||||
|
||||
### Run Web Server
|
||||
|
||||
|
@ -214,7 +214,7 @@ InvenTree configuration can be performed using environment variables, or the `co
|
||||
Edit the configuration file at `/home/inventree/src/InvenTree/config.yaml`.
|
||||
|
||||
!!! info "Config Guidelines"
|
||||
Refer to the [configuration guidelines](../config) for full details.
|
||||
Refer to the [configuration guidelines](./config.md) for full details.
|
||||
|
||||
!!! warning "Configure Database"
|
||||
Ensure database settings are correctly configured before proceeding to the next step! In particular, check that the database connection settings match the database you have created in the previous step.
|
||||
@ -251,10 +251,10 @@ The InvenTree database is now setup and ready to run. A simple development serve
|
||||
|
||||
The InvenTree development server is useful for testing and configuration - and it may be wholly sufficient for a small-scale installation.
|
||||
|
||||
Refer to the [development server instructions](../development) for further information.
|
||||
Refer to the [development server instructions](./development.md) for further information.
|
||||
|
||||
### Production Server
|
||||
|
||||
In a production environment, a more robust server setup is required.
|
||||
|
||||
Refer to the [production server instructions](../production) for further information.
|
||||
Refer to the [production server instructions](./production.md) for further information.
|
||||
|
@ -31,11 +31,11 @@ The bulk of the InvenTree code base supports the custom web server application.
|
||||
|
||||
The webserver code also provides a first-party API for performing database query actions.
|
||||
|
||||
Once a database is setup, you need a way of accessing the data. InvenTree provides a "server" application out of the box, but this may not scale particularly well with multiple users. Instead, InvenTree can be served using a webserver such as [Gunicorn](https://gunicorn.org/). For more information see the [deployment documentation](../deploy).
|
||||
Once a database is setup, you need a way of accessing the data. InvenTree provides a "server" application out of the box, but this may not scale particularly well with multiple users. Instead, InvenTree can be served using a webserver such as [Gunicorn](https://gunicorn.org/). For more information see the [deployment documentation](./production.md).
|
||||
|
||||
### Background Tasks
|
||||
|
||||
A separate application handles management of [background tasks](../../admin/tasks), separate to user-facing web requests.
|
||||
A separate application handles management of [background tasks](../admin/tasks.md), separate to user-facing web requests.
|
||||
|
||||
## OS Requirements
|
||||
|
||||
@ -123,7 +123,7 @@ There are multiple ways to get an InvenTree server up and running, of various co
|
||||
|
||||
The recommended method of installing InvenTree is to use [docker](https://www.docker.com). InvenTree provides out-of-the-box support for docker and docker-compose, which provides a simple, reliable and repeatable pipeline for integration into your production environment.
|
||||
|
||||
Refer to the [docker setup instructions](../docker) for further information.
|
||||
Refer to the [docker setup instructions](./docker.md) for further information.
|
||||
|
||||
### Bare Metal
|
||||
|
||||
|
@ -29,7 +29,7 @@ This will create JSON file at the specified location which contains all database
|
||||
|
||||
### Initialize New Database
|
||||
|
||||
Configure the new database using the normal processes (see [Configuration](../config))
|
||||
Configure the new database using the normal processes (see [Configuration](./config.md))
|
||||
|
||||
Then, ensure that the database schema are correctly initialized in the new database:
|
||||
|
||||
|
@ -5,7 +5,7 @@ title: Production Server
|
||||
## Production Server
|
||||
|
||||
!!! warning "Installation"
|
||||
Before continuing, ensure that the [installation steps](../install) have been completed.
|
||||
Before continuing, ensure that the [installation steps](./install.md) have been completed.
|
||||
|
||||
The following instructions provide a reasonably performant server, using [gunicorn](https://gunicorn.org/) as a webserver, and [supervisor](http://supervisord.org/) as a process manager.
|
||||
|
||||
|
Reference in New Issue
Block a user