Skip to content

OliverPA77/previewgenerator

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Preview Generator

Nextcloud app that allows admins to pre-generate previews. The app listens to edit events and stores this information. Once a cron job is triggered it will generate start preview generation. This means that you can better utilize your system by pre-generating previews when your system is normally idle and thus putting less load on your machine when the requests are actually served.

The app does not replace on demand preview generation so if a preview is requested before it is pre-generated it will still be shown.

How to isntall

  • Install directly from within your Nextcloud from the app store
  • Clone this reposotiry in you Nextcloud app folder

How to use the app

  1. Install the app
  2. Enable the app
  3. Add a (sytem) cron job for ./occ preview:pre-generate
  • I run it every 10 minutes

How does the app work

  1. Listen to events that a file has been writen or modified and store it in the database
  2. On cron run request previews for the files that have been writen or modified

If a preview already exists at step 2 then requesting it is really cheap. If not it will be generated. Depending on the sizes of the files and the hardware you are running on the time this takes can vary.

Commands

preview:delete_old

This removes the previews from the old preview location that was used before Nextcloud 11. That has some issues. Note that the gallery shipped with Nextcloud 11 did not yet use this location. So you might want to run it again with Nextcloud 12.

preview:generate-all [user-id]

Loop over all files and try to generate previews for them. If user-id is supplied just loop over the files for that user.

preview:pre-generate

Do the actual pregeneration. This means only for new or modified files (since the app was enabled).

FAQ

Why can't I use webcron?

Preview generation can be a very long running job. Thus we need a system that does not time out.

It sometimes crashed

Yes this happens. Most of it is due corrupted files not being handled that gracefully in the Nextcloud server. Improvements in this area are coming with Nextcloud 12

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.

Packages

No packages published

Languages

  • PHP 96.1%
  • Makefile 3.9%