inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-15 03:25:42 +00:00
Code Activity

refactor(frontend): seperate Alerts into own component (#9442)

Browse Source 
* refactor(frontend): seperate Alerts into own component

* refactor debug mode info

* add error code for debug mode and render help links in alerts

* add error message for background worker

* add error code for server restart required

* Add error code for missing email settings

* fix various typings

* add error code for missing migrations
This commit is contained in:
Matthias Mair
2025-04-03 09:03:07 +02:00
committed by GitHub
parent c4f98cd6a1
commit b48ceb00f2
10 changed files with 185 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/docs/settings/error_codes.md
View File

@ -52,6 +52,40 @@ See [INVE-W1](#inve-w1)
See [INVE-W1](#inve-w1)
#### INVE-W4
**Server is running in debug mode - Backend**
InvenTree is running in debug mode. This is **not** recommended for production use, as it exposes sensitive information and makes the server more vulnerable to attacks. Debug mode is not intended for production/exposed instances, **even for short duration**.
It is recommended to run InvenTree in production mode for better security and performance. See [Debug Mode Information](../start/intro.md#debug-mode).
#### INVE-W5
**Background worker process not running - Backend**
The background worker seems to not be running. This is detected by a heartbeat that runs all 5 minutes - this error triggers after not being run in the last 10 minutes.
Check if the process for background workers is running and reaching the database. Steps vary between deployment methods.
See [Background Worker Information](../start/processes.md#background-worker).
#### INVE-W6
**Server restart required - Backend**
The server needs a restart due to changes in settings. Steps very between deployment methods.
#### INVE-W7
**Email settings not configured - Backend**
Not all required settings for sending emails are configured. Not having an email provider configured might lead to degraded processes as password reset, update notifications and user notifications can not work. Setting up email is recommended.
See [Email information](../start/config.md#email-settings).
#### INVE-W8
**Database Migrations required - Backend**
There are database migrations waiting to be applied. This might lead to integrity and availability issues. Applying migrations as soon as possible is recommended.
Some deployment methods support [auto applying of updates](../start/config.md#auto-update). See also [Perform Database Migrations](../start/install.md#perform-database-migrations).
Steps very between deployment methods.
### INVE-I (InvenTree Information)
Information — These are not errors but information messages. They might point out potential issues or just provide information.

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

@ -125,9 +125,9 @@ Running in DEBUG mode provides many handy development features, however it is st
So, for a production setup, you should set `INVENTREE_DEBUG=false` in the [configuration options](./config.md).
### Potential Issues
### Turning Debug Mode off
Turning off DEBUG mode creates further work for the system administrator. In particular, when running in DEBUG mode, the InvenTree web server natively manages *static* and *media* files, which means that when DEBUG mode is *disabled*, the InvenTree server can no longer run as a monolithic process.
When running in DEBUG mode, the InvenTree web server natively manages *static* and *media* files, which means that when DEBUG mode is *disabled*, the proxy setup has to be configured to handle this.
!!! info "Read More"
Refer to the [proxy server documentation](./processes.md#proxy-server) for more details