Skip to content

docs: mention parallel generation of previews #579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
st3iny merged 1 commit into from
Nov 8, 2025
Merged

docs: mention parallel generation of previews #579

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,25 @@ are running on the time this takes can vary.

## Commands

#### `preview:generate-all [--path=PATH ...] [user_id ...]`
#### `preview:generate-all [--workers=WORKERS] [--path=PATH ...] [user_id ...]`

Loop over all files and try to generate previews for them. If one or multiple user ids are supplied
it will just loop over the files of those users. You can also limit the generation to one or more
paths using `--path="/[username]/files/[folder path]"`, e.g. `--path="/alice/files/Photos"`. Note
that all given user_ids are ignored if at least one path is specified.
paths using `--path="/[username]/files/[folder path]"`, for example,
`--path="/alice/files/Photos"`. Note that all given user_ids are ignored if at least one path is
specified.

You can optionally spawn multiple parallel workers to speed up the generation of previews. Simply
pass the desired worker count to the `--workers` option, for example, `--workers=10`.

Use `<command> -vv` to get a more verbose output if you are interested to see which files are being
processed.

#### `preview:pre-generate`

Do the actual pre-generation. This means only for new or modified files (since the app was enabled
or the last pre-generation was done).
or the last pre-generation was done). It is possible to run the command multiple times in parallel
to speed up the generation of previews.

Use `<command> -vv` to get a more verbose output if you are interested to see which files are being
processed.
Expand Down Expand Up @@ -101,11 +109,6 @@ the aspect ratio.
Preview generation can be a very long running job. Thus we need a system that
does not time out.

### I get "Command already running"

Yes this happens when the `pre-generate` command crashes. No worries the lock
will be released after 30 minutes of inactivity from the app. So go grab a cookie.

### What if I'm using Nextcloud All In One?

Follow [these instructions](https://github.com/nextcloud/all-in-one/discussions/542)
Expand Down