inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2026-04-12 06:18:48 +00:00
Code Activity

Add documentation on background worker configuration options (#11673)

Browse Source
This commit is contained in:
Oliver
2026-04-04 12:41:55 +11:00
committed by GitHub
parent 3a1e860789
commit a721a0fe35
3 changed files with 28 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/start/config.md
View File

@@ -185,7 +185,6 @@ Proxy configuration can be complex, and any configuration beyond the basic setup
Refer to the [proxy server documentation](./processes.md#proxy-server) for more information.
## Admin Site
Django provides a powerful [administrator interface]({% include "django.html" %}/ref/contrib/admin/) which can be used to manage the InvenTree database. This interface is enabled by default, and available at the `/admin/` URL.
@@ -468,6 +467,17 @@ The login-experience can be altered with the following settings:
Custom authentication backends can be used by specifying them here. These can for example be used to add [LDAP / AD login](https://django-auth-ldap.readthedocs.io/en/latest/) to InvenTree
## Background Worker Options
The following options are available for configuring the InvenTree [background worker process](./processes.md#background-worker):
| Environment Variable | Configuration File | Description | Default |
| --- | --- | --- | --- |
| INVENTREE_BACKGROUND_WORKERS | background.workers | Number of background worker processes | 1 |
| INVENTREE_BACKGROUND_TIMEOUT | background.timeout | Timeout for background worker tasks (seconds) | 90 |
| INVENTREE_BACKGROUND_RETRY | background.retry | Time to wait before retrying a background task (seconds) | 300 |
| INVENTREE_BACKGROUND_MAX_ATTEMPTS | background.max_attempts | Maximum number of attempts for a background task | 5 |
## Sentry Integration
The InvenTree server can be integrated with the [sentry.io](https://sentry.io) monitoring service, for error logging and performance tracking.

4
docs/docs/start/processes.md
View File

@@ -143,3 +143,7 @@ InvenTree uses the [Redis](https://redis.io/) cache server to manage cache data.
!!! tip "Enable Cache"
While a redis container is provided in the default configuration, by default it is not enabled in the InvenTree server. You can enable redis cache support by following the [caching configuration guide](./config.md#caching)
### Configuration
Refer to the [background worker configuration options](./config.md#background-worker-options) for more information on configuring the background worker process.