Photoprism®

Description / name	Input element
Your domain name

Overview

Photoprism® is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud.

Manual

Releases

Community

---

Deployment

sb install sandbox-photoprism

Usage

Visit https://photoprism.iYOUR_DOMAIN_NAMEi.

Basics

• Default login:

Username: admin
Password: your_normal_password

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   photoprism_name: "custom_value"
   

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like photoprism_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

   Instead, use the corresponding _custom variable (like photoprism_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

photoprism_name

# Type: string
photoprism_name: photoprism

photoprism_role_web_subdomain

# Type: string
photoprism_role_web_subdomain: "{{ photoprism_name }}"

photoprism_role_web_domain

# Type: string
photoprism_role_web_domain: "{{ user.domain }}"

photoprism_role_web_port

# Type: string
photoprism_role_web_port: "2342"

photoprism_role_web_url

# Type: string
photoprism_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='photoprism') + '.' + lookup('role_var', '_web_domain', role='photoprism')
                          if (lookup('role_var', '_web_subdomain', role='photoprism') | length > 0)
                          else lookup('role_var', '_web_domain', role='photoprism')) }}"

photoprism_role_dns_record

# Type: string
photoprism_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='photoprism') }}"

photoprism_role_dns_zone

# Type: string
photoprism_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='photoprism') }}"

photoprism_role_dns_proxy

# Type: bool (true/false)
photoprism_role_dns_proxy: "{{ dns_proxied }}"

photoprism_role_traefik_sso_middleware

# Type: string
photoprism_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

photoprism_role_traefik_middleware_default

# Type: string
photoprism_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

photoprism_role_traefik_middleware_custom

# Type: string
photoprism_role_traefik_middleware_custom: ""

photoprism_role_traefik_certresolver

# Type: string
photoprism_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

photoprism_role_traefik_enabled

# Type: bool (true/false)
photoprism_role_traefik_enabled: true

photoprism_role_traefik_api_enabled

# Type: bool (true/false)
photoprism_role_traefik_api_enabled: false

photoprism_role_traefik_api_endpoint

# Type: string
photoprism_role_traefik_api_endpoint: ""

Container

photoprism_role_docker_container

# Type: string
photoprism_role_docker_container: "{{ photoprism_name }}"

Image

photoprism_role_docker_image_pull

# Type: bool (true/false)
photoprism_role_docker_image_pull: true

photoprism_role_docker_image_tag

# Type: string
photoprism_role_docker_image_tag: "latest"

photoprism_role_docker_image_repo

# Type: string
photoprism_role_docker_image_repo: "photoprism/photoprism"

photoprism_role_docker_image

# Type: string
photoprism_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='photoprism') }}:{{ lookup('role_var', '_docker_image_tag', role='photoprism') }}"

Envs

photoprism_role_docker_envs_default

# Type: dict
photoprism_role_docker_envs_default:
  PHOTOPRISM_ADMIN_PASSWORD: "{{ user.pass }}"
  PHOTOPRISM_AUTH_MODE: "password"
  PHOTOPRISM_SITE_URL: "{{ lookup('role_var', '_web_url', role='photoprism') }}"
  PHOTOPRISM_ORIGINALS_LIMIT: "5000"
  PHOTOPRISM_HTTP_COMPRESSION: "gzip"
  PHOTOPRISM_LOG_LEVEL: "info"
  PHOTOPRISM_READONLY: "false"
  PHOTOPRISM_EXPERIMENTAL: "false"
  PHOTOPRISM_DISABLE_CHOWN: "false"
  PHOTOPRISM_DISABLE_WEBDAV: "false"
  PHOTOPRISM_DISABLE_SETTINGS: "false"
  PHOTOPRISM_DISABLE_TENSORFLOW: "false"
  PHOTOPRISM_DISABLE_FACES: "false"
  PHOTOPRISM_DISABLE_CLASSIFICATION: "false"
  PHOTOPRISM_DISABLE_RAW: "false"
  PHOTOPRISM_RAW_PRESETS: "false"
  PHOTOPRISM_JPEG_QUALITY: "85"
  PHOTOPRISM_DETECT_NSFW: "false"
  PHOTOPRISM_UPLOAD_NSFW: "false"
  PHOTOPRISM_DATABASE_DRIVER: "mysql"
  PHOTOPRISM_DATABASE_SERVER: "mariadb:3306"
  PHOTOPRISM_DATABASE_NAME: "photoprisms"
  PHOTOPRISM_DATABASE_USER: "root"
  PHOTOPRISM_DATABASE_PASSWORD: "password321"
  PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App"
  PHOTOPRISM_SITE_DESCRIPTION: "Trying out PhotoPrism!"
  PHOTOPRISM_SITE_AUTHOR: "{{ user.name }}"
  PHOTOPRISM_INIT: "gpu tensorflow"

photoprism_role_docker_envs_custom

# Type: dict
photoprism_role_docker_envs_custom: {}

Volumes

photoprism_role_docker_volumes_default

# Type: list
photoprism_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='photoprism') }}/originals:/photoprism/originals"
  - "{{ lookup('role_var', '_paths_location', role='photoprism') }}/import:/photoprism/import"
  - "{{ lookup('role_var', '_paths_location', role='photoprism') }}/storage:/photoprism/storage"

photoprism_role_docker_volumes_custom

# Type: list
photoprism_role_docker_volumes_custom: []

Hostname

photoprism_role_docker_hostname

# Type: string
photoprism_role_docker_hostname: "{{ photoprism_name }}"

Networks

photoprism_role_docker_networks_alias

# Type: string
photoprism_role_docker_networks_alias: "{{ photoprism_name }}"

photoprism_role_docker_networks_default

# Type: list
photoprism_role_docker_networks_default: []

photoprism_role_docker_networks_custom

# Type: list
photoprism_role_docker_networks_custom: []

Security Opts

photoprism_role_docker_security_opts_default

# Type: list
photoprism_role_docker_security_opts_default:
  - "seccomp=unconfined"
  - "apparmor=unconfined"

photoprism_role_docker_security_opts_custom

# Type: list
photoprism_role_docker_security_opts_custom: []

Working Directory

photoprism_role_docker_working_dir

# Type: string
photoprism_role_docker_working_dir: "/photoprism"

Restart Policy

photoprism_role_docker_restart_policy

# Type: string
photoprism_role_docker_restart_policy: unless-stopped

State

photoprism_role_docker_state

# Type: string
photoprism_role_docker_state: started

User

photoprism_role_docker_user

# Type: string
photoprism_role_docker_user: "{{ uid }}:{{ gid }}"

Dependencies

photoprism_role_depends_on

# Type: string
photoprism_role_depends_on: "mariadb"

photoprism_role_depends_on_delay

# Type: string (quoted number)
photoprism_role_depends_on_delay: "0"

photoprism_role_depends_on_healthchecks

# Type: string ("true"/"false")
photoprism_role_depends_on_healthchecks: "false"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

photoprism_role_docker_blkio_weight

# Type: int
photoprism_role_docker_blkio_weight:

photoprism_role_docker_cpu_period

# Type: int
photoprism_role_docker_cpu_period:

photoprism_role_docker_cpu_quota

# Type: int
photoprism_role_docker_cpu_quota:

photoprism_role_docker_cpu_shares

# Type: int
photoprism_role_docker_cpu_shares:

photoprism_role_docker_cpus

# Type: string
photoprism_role_docker_cpus:

photoprism_role_docker_cpuset_cpus

# Type: string
photoprism_role_docker_cpuset_cpus:

photoprism_role_docker_cpuset_mems

# Type: string
photoprism_role_docker_cpuset_mems:

photoprism_role_docker_kernel_memory

# Type: string
photoprism_role_docker_kernel_memory:

photoprism_role_docker_memory

# Type: string
photoprism_role_docker_memory:

photoprism_role_docker_memory_reservation

# Type: string
photoprism_role_docker_memory_reservation:

photoprism_role_docker_memory_swap

# Type: string
photoprism_role_docker_memory_swap:

photoprism_role_docker_memory_swappiness

# Type: int
photoprism_role_docker_memory_swappiness:

photoprism_role_docker_shm_size

# Type: string
photoprism_role_docker_shm_size:

Security & Devices

photoprism_role_docker_cap_drop

# Type: list
photoprism_role_docker_cap_drop:

photoprism_role_docker_cgroupns_mode

# Type: string
photoprism_role_docker_cgroupns_mode:

photoprism_role_docker_device_cgroup_rules

# Type: list
photoprism_role_docker_device_cgroup_rules:

photoprism_role_docker_device_read_bps

# Type: list
photoprism_role_docker_device_read_bps:

photoprism_role_docker_device_read_iops

# Type: list
photoprism_role_docker_device_read_iops:

photoprism_role_docker_device_requests

# Type: list
photoprism_role_docker_device_requests:

photoprism_role_docker_device_write_bps

# Type: list
photoprism_role_docker_device_write_bps:

photoprism_role_docker_device_write_iops

# Type: list
photoprism_role_docker_device_write_iops:

photoprism_role_docker_devices

# Type: list
photoprism_role_docker_devices:

photoprism_role_docker_devices_default

# Type: string
photoprism_role_docker_devices_default:

photoprism_role_docker_groups

# Type: list
photoprism_role_docker_groups:

photoprism_role_docker_privileged

# Type: bool (true/false)
photoprism_role_docker_privileged:

photoprism_role_docker_userns_mode

# Type: string
photoprism_role_docker_userns_mode:

Networking

photoprism_role_docker_dns_opts

# Type: list
photoprism_role_docker_dns_opts:

photoprism_role_docker_dns_search_domains

# Type: list
photoprism_role_docker_dns_search_domains:

photoprism_role_docker_dns_servers

# Type: list
photoprism_role_docker_dns_servers:

photoprism_role_docker_domainname

# Type: string
photoprism_role_docker_domainname:

photoprism_role_docker_exposed_ports

# Type: list
photoprism_role_docker_exposed_ports:

photoprism_role_docker_hosts

# Type: dict
photoprism_role_docker_hosts:

photoprism_role_docker_hosts_use_common

# Type: bool (true/false)
photoprism_role_docker_hosts_use_common:

photoprism_role_docker_ipc_mode

# Type: string
photoprism_role_docker_ipc_mode:

photoprism_role_docker_links

# Type: list
photoprism_role_docker_links:

photoprism_role_docker_network_mode

# Type: string
photoprism_role_docker_network_mode:

photoprism_role_docker_pid_mode

# Type: string
photoprism_role_docker_pid_mode:

photoprism_role_docker_ports

# Type: list
photoprism_role_docker_ports:

photoprism_role_docker_uts

# Type: string
photoprism_role_docker_uts:

Storage

photoprism_role_docker_keep_volumes

# Type: bool (true/false)
photoprism_role_docker_keep_volumes:

photoprism_role_docker_mounts

# Type: list
photoprism_role_docker_mounts:

photoprism_role_docker_storage_opts

# Type: dict
photoprism_role_docker_storage_opts:

photoprism_role_docker_tmpfs

# Type: list
photoprism_role_docker_tmpfs:

photoprism_role_docker_volume_driver

# Type: string
photoprism_role_docker_volume_driver:

photoprism_role_docker_volumes_from

# Type: list
photoprism_role_docker_volumes_from:

photoprism_role_docker_volumes_global

# Type: bool (true/false)
photoprism_role_docker_volumes_global:

Monitoring & Lifecycle

photoprism_role_docker_auto_remove

# Type: bool (true/false)
photoprism_role_docker_auto_remove:

photoprism_role_docker_cleanup

# Type: bool (true/false)
photoprism_role_docker_cleanup:

photoprism_role_docker_force_kill

# Type: string
photoprism_role_docker_force_kill:

photoprism_role_docker_healthcheck

# Type: dict
photoprism_role_docker_healthcheck:

photoprism_role_docker_healthy_wait_timeout

# Type: int
photoprism_role_docker_healthy_wait_timeout:

photoprism_role_docker_init

# Type: bool (true/false)
photoprism_role_docker_init:

photoprism_role_docker_kill_signal

# Type: string
photoprism_role_docker_kill_signal:

photoprism_role_docker_log_driver

# Type: string
photoprism_role_docker_log_driver:

photoprism_role_docker_log_options

# Type: dict
photoprism_role_docker_log_options:

photoprism_role_docker_oom_killer

# Type: bool (true/false)
photoprism_role_docker_oom_killer:

photoprism_role_docker_oom_score_adj

# Type: int
photoprism_role_docker_oom_score_adj:

photoprism_role_docker_output_logs

# Type: bool (true/false)
photoprism_role_docker_output_logs:

photoprism_role_docker_paused

# Type: bool (true/false)
photoprism_role_docker_paused:

photoprism_role_docker_recreate

# Type: bool (true/false)
photoprism_role_docker_recreate:

photoprism_role_docker_restart_retries

# Type: int
photoprism_role_docker_restart_retries:

photoprism_role_docker_stop_timeout

# Type: int
photoprism_role_docker_stop_timeout:

Other Options

photoprism_role_docker_capabilities

# Type: list
photoprism_role_docker_capabilities:

photoprism_role_docker_cgroup_parent

# Type: string
photoprism_role_docker_cgroup_parent:

photoprism_role_docker_commands

# Type: list
photoprism_role_docker_commands:

photoprism_role_docker_create_timeout

# Type: int
photoprism_role_docker_create_timeout:

photoprism_role_docker_entrypoint

# Type: string
photoprism_role_docker_entrypoint:

photoprism_role_docker_env_file

# Type: string
photoprism_role_docker_env_file:

photoprism_role_docker_labels

# Type: dict
photoprism_role_docker_labels:

photoprism_role_docker_labels_use_common

# Type: bool (true/false)
photoprism_role_docker_labels_use_common:

photoprism_role_docker_read_only

# Type: bool (true/false)
photoprism_role_docker_read_only:

photoprism_role_docker_runtime

# Type: string
photoprism_role_docker_runtime:

photoprism_role_docker_sysctls

# Type: list
photoprism_role_docker_sysctls:

photoprism_role_docker_ulimits

# Type: list
photoprism_role_docker_ulimits:

photoprism_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
photoprism_role_autoheal_enabled: true

photoprism_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
photoprism_role_depends_on: ""

photoprism_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
photoprism_role_depends_on_delay: "0"

photoprism_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
photoprism_role_depends_on_healthchecks:

photoprism_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
photoprism_role_diun_enabled: true

photoprism_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
photoprism_role_dns_enabled: true

photoprism_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
photoprism_role_docker_controller: true

photoprism_role_docker_image_repo

# Type: string
photoprism_role_docker_image_repo:

photoprism_role_docker_image_tag

# Type: string
photoprism_role_docker_image_tag:

photoprism_role_docker_volumes_download

# Type: bool (true/false)
photoprism_role_docker_volumes_download:

photoprism_role_paths_location

# Type: string
photoprism_role_paths_location:

photoprism_role_themepark_addons

# Type: string
photoprism_role_themepark_addons:

photoprism_role_themepark_app

# Type: string
photoprism_role_themepark_app:

photoprism_role_themepark_theme

# Type: string
photoprism_role_themepark_theme:

photoprism_role_traefik_api_endpoint

# Type: dict/omit
photoprism_role_traefik_api_endpoint:

photoprism_role_traefik_api_middleware

# Type: string
photoprism_role_traefik_api_middleware:

photoprism_role_traefik_api_middleware_http

# Type: string
photoprism_role_traefik_api_middleware_http:

photoprism_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
photoprism_role_traefik_autodetect_enabled: false

photoprism_role_traefik_certresolver

# Type: string
photoprism_role_traefik_certresolver:

photoprism_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
photoprism_role_traefik_crowdsec_enabled: false

photoprism_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
photoprism_role_traefik_error_pages_enabled: false

photoprism_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
photoprism_role_traefik_gzip_enabled: false

photoprism_role_traefik_middleware_http

# Type: string
photoprism_role_traefik_middleware_http:

photoprism_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
photoprism_role_traefik_middleware_http_api_insecure:

photoprism_role_traefik_middleware_http_insecure

# Type: bool (true/false)
photoprism_role_traefik_middleware_http_insecure:

photoprism_role_traefik_priority

# Type: string
photoprism_role_traefik_priority:

photoprism_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
photoprism_role_traefik_robot_enabled: true

photoprism_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
photoprism_role_traefik_tailscale_enabled: false

photoprism_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
photoprism_role_traefik_wildcard_enabled: true

photoprism_role_web_domain

# Type: string
photoprism_role_web_domain:

photoprism_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
photoprism_role_web_fqdn_override:

Example Override

photoprism_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "photoprism2.{{ user.domain }}"
  - "photoprism.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

photoprism_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
photoprism_role_web_host_override:

Example Override

photoprism_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'photoprism2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

photoprism_role_web_http_port

# Type: string (quoted number)
photoprism_role_web_http_port:

photoprism_role_web_http_scheme

# Type: string ("http"/"https")
photoprism_role_web_http_scheme:

photoprism_role_web_http_serverstransport

# Type: dict/omit
photoprism_role_web_http_serverstransport:

photoprism_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
photoprism_role_web_scheme:

photoprism_role_web_serverstransport

# Type: dict/omit
photoprism_role_web_serverstransport:

photoprism_role_web_subdomain

# Type: string
photoprism_role_web_subdomain:

photoprism_role_web_url

# Type: string
photoprism_role_web_url: