PhotoPrism-Helper

PhotoPrism-Helper

Docker app from Aerilym's Repository

Overview

PhotoPrism Helper is an unofficial companion tool created for use alongside PhotoPrism. This project isn't associated with the PhotoPrism project, it's just a companion tool created to extend the functionality of PhotoPrism.

Runtime arguments

Network
bridge
Shell
sh
Privileged
false

Template configuration

Host PortPorttcp

The port the helper is hosted on. Container Port: 2343

Target
2343
Default
2342
Value
2343
PhotoPrism Site URLVariable

Container Variable: PHOTOPRISM_SITE_URL

Target
PHOTOPRISM_SITE_URL
Default
http://localhost:2342
Value
http://localhost:2342
PhotoPrism UsernameVariable

The PhotoPrism username you want the helper to use for access.

Target
PHOTOPRISM_USERNAME
Default
admin
Value
admin
PhotoPrism PasswordVariable

The PhotoPrism password associated with the username.

Target
PHOTOPRISM_PASSWORD
Helper API KeyVariable

The API key you'll use to query the helper API.

Target
APIKEY
Default
testkey
Value
testkey
TimezoneVariable

The timezone of your instance.

Target
TIMEZONE
Default
Australia/Melbourne
Value
Australia/Melbourne
Import TimeoutVariable

The number of milliseconds the import function should wait for a success message before timing out.

Target
IMPORT_TIMEOUT
Default
300000
Value
300000
Auto ImportVariable

Enable/Disable the auto-import feature.

Target
AUTO_IMPORT
Default
false
Value
false
Auto Import Cron ScheduleVariable

The cron expression for when to run auto-import.

Target
AUTO_IMPORT_CRON
Default
0 0 4 * * * *
Value
0 0 5 * * * *
Index After Auto ImportVariable

Enable/Disable the index after auto-importing feature.

Target
INDEX_AFTER_AUTO_IMPORT
Default
false
Value
false
Auto IndexVariable

Enable/Disable the auto-index feature.

Target
AUTO_INDEX
Default
false
Value
false
Auto Index Cron ScheduleVariable

The cron expression for when to run auto-index.

Target
AUTO_INDEX_CRON
Default
0 0 6 * * * *
Value
0 0 5 * * * *
ISDOCKERVariable

Tells the helper instance if it is running in a Docker container. Container Variable: ISDOCKER

Default
1
Value
1
Logfile PathVariable

The logging file path.

Target
LOGFILE_PATH
Default
logs/local.log
Value
logs/local.log
Log Level - ConsoleVariable

The log level to apply to the console log.

Target
LOGLEVEL_CONSOLE
Default
info
Value
info
Log Level - FileVariable

The log level to apply to the file log.

Target
LOGLEVEL_FILE
Default
error
Value
error
Send Errors to the DeveloperVariable

Enable/Disable sending errors/exceptions to the dev.

Target
SEND_ERRORS
Default
true
Value
true
Error Log URL (Dev)Variable

The URL to send errors to. (Don't change unless you're running your own fork of the helper)

Target
ERROR_LOG_URL
Error Log Key (Dev)Variable

The API key sent with error logs to the external server.

Target
ERROR_LOG_KEY
Anonymise Error LogsVariable

Enable/Disable anonymising externally sent error logs.

Target
ERROR_LOG_IDENTITY_ANONYMISED
Default
false
Value
false
Send Options in Error LogVariable

Enable/Disable sending your configuration options with externally sent errors.

Target
ERROR_LOG_IDENTITY_SEND_OPTIONS
Default
true
Value
true
Add Logging to External ServerVariable

Enable/Disable sending logs to an external log server.

Target
EXTERNAL_LOG
Default
false
Value
false
External Log DepthVariable

The log level to apply to the external log.

Target
EXTERNAL_LOG_DEPTH
Default
info
Value
info
External Log URLVariable

The URL of the external log server.

Target
EXTERNAL_LOG_URL
External Log API KeyVariable

The API key sent with logs sent to the external log server.

Target
EXTERNAL_LOG_KEY
Anonymise External LogsVariable

Enable/Disable anonymising externally sent logs.

Target
EXTERNAL_LOG_IDENTITY_ANONYMISED
Default
false
Value
false
Send Options in External LogsVariable

Enable/Disable sending your configuration options with externally sent logs.

Target
EXTERNAL_LOG_IDENTITY_SEND_OPTIONS
Default
true
Value
true

Download Statistics

5,607
Total Downloads

Details

Repository
aerilym/photoprism-helper:master
Last Updated2026-02-15
First Seen2022-08-22

Run PhotoPrism-Helper on Unraid.

PhotoPrism-Helper is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.