Sign inSign up

dokeraj/photoprism-reindexer

By dokeraj

•Updated almost 4 years ago

Reindexing scheduler for Photoprism

Image
0

636

dokeraj/photoprism-reindexer repository overview

This is a python script that makes scheduled command calls (photoprism index) for reindexing (scanning for new photos) for Photoprism⁠.

⁠PREREQUISITES: In order to use this docker script, you need to have a Photoprism docker container up and running.

⁠Supported Architectures

  • armhf - Raspberry Pi 3 and 4
  • amd64

The tag latest is multi-arch, so you can use it for any architecture.

⁠Usage

  1. Spin up Photoprism container, from dockerhub⁠. Have the name of the container handy.
  2. Prepare the config.yml (see just below)

IMPORTANT: you must create the following file named config.yml and place it in a folder, that will be binded to a volume. Otherwise you cannot use this docker image.

⁠config.yml

general_settings:
  ## MANDATORY. Name of your photoprism docker container. You should have the container named: photoprism
  photoprism_container_name: <INSERT YOUR PHOTOPRISM CONTAINER NAME HERE>

## DELETE THE ONE YOU DON'T NEED. This is the schedule when you want the script to run and call the Reindexing command
backup_schedule:
  ## DELETE IF NOT NEEDED
  weekly:
    ## available values are MON, TUE, WED, THU, FRI, SAT, SUN.
    day: <INPUT DAY HERE>
    ## Use HH:mm format and wrap the time in quatation marks e.g. "14:28"
    time: <HH:mm>
  ## DELETE IF NOT NEEDED
  daily:
    ## Use HH:mm format and wrap the time in quatation marks e.g. "14:28"
    time: <HH:mm>
  ## DELETE IF NOT NEEDED. This schedule will run the preview generation command, on the specified day on the last week of the current month
  last_day_of_month:
    ## available values are MON, TUE, WED, THU, FRI, SAT, SUN.
    day: <INPUT DAY HERE>
    ## Use HH:mm format and wrap the time in quatation marks e.g. "14:28"
    time: <HH:mm>

The config.yml can also be found here⁠.

⁠Docker create command

docker create \
--name=prism-reindexer\
-d \
-e TZ=Europe/London \
-v /path/to/your/yaml/config/file:/yaml \
-v /var/run/docker.sock:/var/run/docker.sock \
--restart unless-stopped \
dokeraj/photoprism-reindexer:latest
⁠Creation flags explanation
flagFunction
-e TZ=Europe/LondonMandatory. Set it to your timezone. Note: If not set properly, the scheduled backup/update will not be ran at the specified time!
-v /path/to/your/yaml/config/file:/yamlMandatory. This bind should point to where you have placed your config.yml file, so photoprism-reindexer can read it on startup.
-v /var/run/docker.sock:/var/run/docker.sockMandatory. This bind should be left as it is - it helps the docker container to get access to docker server environment and monitor for events.

⁠Github project

Source code can be found here: PrismReindexer⁠

Tag summary

Content type

Image

Digest

sha256:8556129b6…

Size

22.5 MB

Last updated

almost 4 years ago

docker pull dokeraj/photoprism-reindexer