diff --git a/docs/docs/faq.md b/docs/docs/faq.md index 47617dadc6..3f3bbe01f3 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -98,7 +98,7 @@ Sometimes, users may encounter unexpected error messages when updating their Inv The most common problem here is that the correct sequence of steps has not been followed: -1. Ensure that the InvenTree web server and background worker processes are *halted* +1. Ensure that the InvenTree [web server](./start/processes.md#web-server) and [background worker](./start/processes.md#background-worker) processes are *halted* 1. Update the InvenTree software (e.g. using git or docker, depending on installation method) 1. Run the `invoke update` command 1. Restart the web server and background worker processes @@ -150,7 +150,7 @@ or ### Background Worker "Not Running" -The background worker process must be started separately to the web-server application. +The [background worker process](./start/processes.md#background-worker) must be started separately to the web-server application. From the top-level source directory, run the following command from a separate terminal, while the server is already running: diff --git a/docs/docs/start/index.md b/docs/docs/start/index.md index 9a5b6b8937..c88c642976 100644 --- a/docs/docs/start/index.md +++ b/docs/docs/start/index.md @@ -123,11 +123,14 @@ By default, a production InvenTree installation is configured to run with [DEBUG Running in DEBUG mode provides many handy development features, however it is strongly recommended *NOT* to run in DEBUG mode in a production environment. This recommendation is made because DEBUG mode leaks a lot of information about your installation and may pose a security risk. -So, for a production setup, you should set `INVENTREE_DEBUG=false` in the [configuration options](./config.md). +So, for a production setup, you should ensure that `INVENTREE_DEBUG=false` in the [configuration options](./config.md). + +!!! warning "Security Risk" + Running InvenTree in DEBUG mode in a production environment is a significant security risk, and should be avoided at all costs. ### Turning Debug Mode off -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. +When running in DEBUG mode, the InvenTree web server natively manages *static* and *media* files, which means that when DEBUG mode is *disabled* (which is the default for a production setup), 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 diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md index c2b5b7f71e..1c34fd02f7 100644 --- a/docs/docs/troubleshooting.md +++ b/docs/docs/troubleshooting.md @@ -9,6 +9,12 @@ If you are struggling with an issue which is not covered in the FAQ above, pleas Even if you cannot immediately resolve the issue, the information below will be very useful when reporting the issue on GitHub. +## Error Codes + +InvenTree uses a system of error codes to help identify specific issues. Each error code is prefixed with `INVE-`, followed by a letter indicating the error type, and a number. + +Refer to the [error code documentation](./settings/error_codes.md) for more information on specific error codes. + ## Recent Update If you have recently updated your InvenTree instance, please ensure that you have followed all update instructions carefully. In particular, make sure that you have run any required database migrations using the `invoke update` command.