paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: update celery monitoring docker usage (#5484)

Browse Source 
* docs: update celery monitoring docker usage

* docs: add review comments

Co-Authored-By: shamoon <4887959+shamoon@users.noreply.github.com>
This commit is contained in:
Uli Fahrer 2024-01-22 01:17:55 +01:00 committed by shamoon
parent 85b596d20d
commit f7ab8d23a7
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/advanced_usage.md
View File

@ -434,8 +434,10 @@ to view more detailed information about the health of the celery workers
used for asynchronous tasks. This includes details on currently running, used for asynchronous tasks. This includes details on currently running,
queued and completed tasks, timing and more. Flower can also be used queued and completed tasks, timing and more. Flower can also be used
with Prometheus, as it exports metrics. For details on its capabilities, with Prometheus, as it exports metrics. For details on its capabilities,
refer to the Flower documentation. refer to the [Flower](https://flower.readthedocs.io/en/latest/index.html)
documentation.
Flower can be enabled with the setting [PAPERLESS_ENABLE_FLOWER](configuration/#PAPERLESS_ENABLE_FLOWER).
To configure Flower further, create a `flowerconfig.py` and To configure Flower further, create a `flowerconfig.py` and
place it into the `src/paperless` directory. For a Docker place it into the `src/paperless` directory. For a Docker
installation, you can use volumes to accomplish this: installation, you can use volumes to accomplish this:
@ -444,6 +446,8 @@ installation, you can use volumes to accomplish this:
services: services:
# ... # ...
webserver: webserver:
environment:
- PAPERLESS_ENABLE_FLOWER
ports: ports:
- 5555:5555 # (2)! - 5555:5555 # (2)!
# ... # ...
@ -452,7 +456,7 @@ services:
``` ```
1. Note the `:ro` tag means the file will be mounted as read only. 1. Note the `:ro` tag means the file will be mounted as read only.
2. `flower` runs by default on port 5555, but this can be configured 2. By default, Flower runs on port 5555, but this can be configured.
## Custom Container Initialization ## Custom Container Initialization