From 94f1802f349f9bb5e8134b83f3a332ec2b8e9ad3 Mon Sep 17 00:00:00 2001 From: Richard Steinmetz Date: Sat, 31 Jan 2026 16:56:46 +0100 Subject: [PATCH] docs(readme): mention the new preview:queue-stats command Signed-off-by: Richard Steinmetz --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8cbc5c8..2b1f96b 100644 --- a/README.md +++ b/README.md @@ -54,8 +54,9 @@ are running on the time this takes can vary. By default, the background job to generate previews for modified files is limited to a maximum execution time of five minutes. Additionally, it requires using the cron background job mode. Webcron and AJAX modes are not supported. The background job is limited to prevent stalling the PHP -process. The limits are configurable via app configs (see below) or admins can configure a dedicated -system cron job which runs the `occ preview:pre-generate` command. +process. The limits are configurable via app configs (see below), or admins can configure a dedicated +system cron job which runs the `occ preview:pre-generate` command. You can run the +`occ preview:queue-stats` command to check the performance of your configured preview limit(s). ## Commands @@ -82,6 +83,14 @@ to speed up the generation of previews. Use ` -vv` to get a more verbose output if you are interested to see which files are being processed. +#### `preview:queue-stats` + +Display statistics about the pre-generation queue which is being processed by the background job (if +enabled). If you see a large number of stale previews, you should increase (or remove) the +configured limits of the background job. Please have a look at the app configs below for more +information, especially both `job_max_*` configs. Note that the same queue is used in the +`preview:pre-generation` command which can also be invoked to quickly drain the queue. + ## Available configuration options The value of each option can either be a list of sizes separated by **spaces** or an empty string.