From c45b35be9ee88e51d7bd5ca3d3cd92e59b663492 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Sat, 23 Oct 2021 14:04:53 +0200 Subject: [PATCH] Docker: Improve docker-compose.yml example docs --- docker/examples/arm64/docker-compose.yml | 33 +++++++++++--------- docker/examples/armv7/docker-compose.yml | 30 +++++++++++------- docker/examples/cloud/docker-compose.yml | 27 ++++++++++------ docker/examples/docker-compose.yml | 21 ++++++++----- docker/examples/macos/docker-compose.yml | 19 ++++++----- docker/examples/scheduler/docker-compose.yml | 21 ++++++++----- docker/examples/sqlite/docker-compose.yml | 9 ++++-- docker/examples/windows/docker-compose.yml | 19 ++++++----- 8 files changed, 110 insertions(+), 69 deletions(-) diff --git a/docker/examples/arm64/docker-compose.yml b/docker/examples/arm64/docker-compose.yml index e566ac6fe..ade786671 100644 --- a/docker/examples/arm64/docker-compose.yml +++ b/docker/examples/arm64/docker-compose.yml @@ -13,8 +13,7 @@ version: '3.5' # Your files and passwords will be transmitted in clear text otherwise. # # DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # Start | docker-compose up -d # Stop | docker-compose stop # Update | docker-compose pull @@ -29,17 +28,20 @@ version: '3.5' # Reindex | docker-compose exec photoprism photoprism index -f # Import | docker-compose exec photoprism photoprism import # +# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples. +# # To search originals for faces without a complete rescan: # docker-compose exec photoprism photoprism faces index # # NOTE: All commands may have to be prefixed with "sudo" when not running as root. -# This will point the home directory placeholder ~ to /root in volume mounts. +# This will point the home directory placeholder ~ to /root in volume mounts. services: + # REQUIRED: PhotoPrism Application Server photoprism: - # ATTENTION: photoprism/photoprism-arm64 has been replaced by a single multi-arch image for AMD64, - # ARM64, and ARMv7. Use photoprism/photoprism:preview for testing preview builds or - # photoprism/photoprism:latest for the stable release. + # NOTE: photoprism/photoprism-arm64 has been replaced by a single multi-arch image for AMD64, + # ARM64, and ARMv7. Use photoprism/photoprism:preview for testing preview builds or + # photoprism/photoprism:latest for the stable release. image: photoprism/photoprism:latest # Owners of ARMv7-based devices may have to explicitly specify the image architecture: # platform: "linux/arm" @@ -78,11 +80,11 @@ services: PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive PHOTOPRISM_UPLOAD_NSFW: "true" # Allow uploads that MAY be offensive # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that doesn't require a server - PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB (or MySQL) instead of SQLite for improved performance - PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) - PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database schema name - PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database user name - PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database user password + PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB or MySQL database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB or MySQL database user password PHOTOPRISM_SITE_TITLE: "PhotoPrism" PHOTOPRISM_SITE_CAPTION: "Browse Your Life" PHOTOPRISM_SITE_DESCRIPTION: "" @@ -107,6 +109,8 @@ services: # Cache, session, thumbnail, and sidecar files will be created in the *storage* folder (never remove): - "./storage:/photoprism/storage" + # RECOMMENDED: MariaDB Server, a MySQL-compatible Database + # see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: restart: unless-stopped image: arm64v8/mariadb:10.6 @@ -122,9 +126,9 @@ services: MYSQL_USER: photoprism MYSQL_PASSWORD: insecure - # ATTENTION: Owners of ARMv7-based devices have to revert to an alternative image if they want to use MariaDB. - # The official image is available for AMD64 and ARM64 only. Pay close attention to changed directory - # and environment variable names. + # OPTIONAL: Owners of ARMv7-based devices have to revert to an alternative image if they want to use MariaDB. + # The official image is available for AMD64 and ARM64 only. Pay close attention to changed directory + # and environment variable names. # # mariadb: # restart: unless-stopped @@ -142,6 +146,7 @@ services: # MYSQL_PASSWORD: insecure # OPTIONAL: Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available. + # see https://docs.photoprism.org/getting-started/updates/#watchtower # # watchtower: # restart: unless-stopped diff --git a/docker/examples/armv7/docker-compose.yml b/docker/examples/armv7/docker-compose.yml index 63ef9caba..46616861f 100644 --- a/docker/examples/armv7/docker-compose.yml +++ b/docker/examples/armv7/docker-compose.yml @@ -10,8 +10,7 @@ version: '3.5' # Your files and passwords will be transmitted in clear text otherwise. # # DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # Start | docker-compose up -d # Stop | docker-compose stop # Update | docker-compose pull @@ -26,17 +25,20 @@ version: '3.5' # Reindex | docker-compose exec photoprism photoprism index -f # Import | docker-compose exec photoprism photoprism import # +# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples. +# # To search originals for faces without a complete rescan: # docker-compose exec photoprism photoprism faces index # # NOTE: All commands may have to be prefixed with "sudo" when not running as root. -# This will point the home directory placeholder ~ to /root in volume mounts. +# This will point the home directory placeholder ~ to /root in volume mounts. services: + # REQUIRED: PhotoPrism Application Server photoprism: - # ATTENTION: photoprism/photoprism-arm64 has been replaced by a single multi-arch image for AMD64, - # ARM64, and ARMv7. Use photoprism/photoprism:preview for testing preview builds or - # photoprism/photoprism:latest for the stable release. + # NOTE: photoprism/photoprism-arm64 has been replaced by a single multi-arch image for AMD64, + # ARM64, and ARMv7. Use photoprism/photoprism:preview for testing preview builds or + # photoprism/photoprism:latest for the stable release. image: photoprism/photoprism:latest platform: "linux/arm" depends_on: @@ -73,11 +75,11 @@ services: PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive PHOTOPRISM_UPLOAD_NSFW: "true" # Allow uploads that MAY be offensive # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that doesn't require a server - PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB (or MySQL) instead of SQLite for improved performance - PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) - PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database schema name - PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database user name - PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database user password + PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB or MySQL database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB or MySQL database user password PHOTOPRISM_SITE_TITLE: "PhotoPrism" PHOTOPRISM_SITE_CAPTION: "Browse Your Life" PHOTOPRISM_SITE_DESCRIPTION: "" @@ -102,8 +104,11 @@ services: # Cache, session, thumbnail, and sidecar files will be created in the *storage* folder (never remove): - "./storage:/photoprism/storage" + # RECOMMENDED: MariaDB Server, a MySQL-compatible Database + # see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql + # # NOTE: Owners of ARMv7-based devices have to revert to lscr.io/linuxserver/mariadb:latest if they - # want to use MariaDB. The official image is available for AMD64 and ARM64 only. + # want to use MariaDB. The official image is available for AMD64 and ARM64 only. mariadb: restart: unless-stopped image: lscr.io/linuxserver/mariadb:latest @@ -120,6 +125,7 @@ services: MYSQL_PASSWORD: insecure # OPTIONAL: Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available. + # see https://docs.photoprism.org/getting-started/updates/#watchtower # # watchtower: # restart: unless-stopped diff --git a/docker/examples/cloud/docker-compose.yml b/docker/examples/cloud/docker-compose.yml index 15a58e761..7773c1a1e 100644 --- a/docker/examples/cloud/docker-compose.yml +++ b/docker/examples/cloud/docker-compose.yml @@ -46,7 +46,7 @@ version: '3.5' # See jobs.ini for details. # # SYSTEM REQUIREMENTS -# ------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # # We recommend hosting PhotoPrism on a server with at least 2 cores and # 4 GB of memory. Beyond these minimum requirements, the amount of RAM @@ -57,8 +57,7 @@ version: '3.5' # will be disabled on servers with less than 2 GB of physical memory. # # DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # Start | docker-compose up -d # Stop | docker-compose stop # Update | docker-compose pull @@ -73,11 +72,13 @@ version: '3.5' # Reindex | docker-compose exec photoprism photoprism index -f # Import | docker-compose exec photoprism photoprism import # +# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples. +# # To search originals for faces without a complete rescan: # docker-compose exec photoprism photoprism faces index # # USING LET'S ENCRYPT HTTPS -# ------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # # If your server has a public domain name, please disable the self-signed # certificate and enable domain based routing in docker-compose.yml and @@ -91,9 +92,9 @@ version: '3.5' # docker-compose up -d # # You should now be able to access your instance without security warnings. -# ------------------------------------------------------------------------- services: + # REQUIRED: PhotoPrism Application Server photoprism: restart: always # Use photoprism/photoprism:preview for testing preview builds: @@ -146,11 +147,11 @@ services: PHOTOPRISM_DARKTABLE_PRESETS: "false" # Enables Darktable presets and disables concurrent RAW conversion PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive (requires TensorFlow) PHOTOPRISM_UPLOAD_NSFW: "true" # Allow uploads that MAY be offensive - PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB (or MySQL) instead of SQLite for improved performance - PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) - PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database schema name - PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database user name - PHOTOPRISM_DATABASE_PASSWORD: "_admin_password_" # MariaDB database user password + PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB or MySQL database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: "_admin_password_" # MariaDB or MySQL database user password PHOTOPRISM_INIT: "tensorflow-amd64-avx2" HOME: "/photoprism" working_dir: "/photoprism" @@ -163,6 +164,7 @@ services: - "./storage:/photoprism/storage" - "./backup:/var/lib/photoprism" + # REQUIRED: Traefik Reverse Proxy traefik: restart: always image: traefik:v2.4 @@ -179,6 +181,8 @@ services: - "./traefik.yaml:/etc/traefik/traefik.yaml" - "./certs/:/certs/" + # RECOMMENDED: MariaDB Server, a MySQL-compatible Database + # see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: restart: always image: mariadb:10.6 @@ -195,6 +199,7 @@ services: MYSQL_USER: "photoprism" MYSQL_PASSWORD: "_admin_password_" + # RECOMMENDED: Ofelia Job Runner ofelia: restart: always image: mcuadros/ofelia:latest @@ -203,6 +208,8 @@ services: - "/var/run/docker.sock:/var/run/docker.sock:ro" - "./jobs.ini:/etc/ofelia/config.ini" + # RECOMMENDED: Upgrades automatically, whenever there is a new Docker image available. + # see https://docs.photoprism.org/getting-started/updates/#watchtower watchtower: restart: always image: containrrr/watchtower diff --git a/docker/examples/docker-compose.yml b/docker/examples/docker-compose.yml index ada5da21a..3985dea2e 100644 --- a/docker/examples/docker-compose.yml +++ b/docker/examples/docker-compose.yml @@ -10,8 +10,7 @@ version: '3.5' # Your files and passwords will be transmitted in clear text otherwise. # # DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # Start | docker-compose up -d # Stop | docker-compose stop # Update | docker-compose pull @@ -26,13 +25,16 @@ version: '3.5' # Reindex | docker-compose exec photoprism photoprism index -f # Import | docker-compose exec photoprism photoprism import # +# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples. +# # To search originals for faces without a complete rescan: # docker-compose exec photoprism photoprism faces index # # NOTE: All commands may have to be prefixed with "sudo" when not running as root. -# This will point the home directory placeholder ~ to /root in volume mounts. +# This will point the home directory placeholder ~ to /root in volume mounts. services: + # REQUIRED: PhotoPrism Application Server photoprism: # Use photoprism/photoprism:preview for testing preview builds: image: photoprism/photoprism:latest @@ -68,11 +70,11 @@ services: PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive (requires TensorFlow) PHOTOPRISM_UPLOAD_NSFW: "true" # Allow uploads that MAY be offensive # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that doesn't require a server - PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB (or MySQL) instead of SQLite for improved performance - PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) - PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database schema name - PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database user name - PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database user password + PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB or MySQL database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB or MySQL database user password PHOTOPRISM_SITE_TITLE: "PhotoPrism" PHOTOPRISM_SITE_CAPTION: "Browse Your Life" PHOTOPRISM_SITE_DESCRIPTION: "" @@ -107,6 +109,8 @@ services: # Cache, session, thumbnail, and sidecar files will be created in the *storage* folder (never remove): - "./storage:/photoprism/storage" + # RECOMMENDED: MariaDB Server, a MySQL-compatible Database + # see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: restart: unless-stopped image: mariadb:10.6 @@ -123,6 +127,7 @@ services: MYSQL_PASSWORD: insecure # OPTIONAL: Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available. + # see https://docs.photoprism.org/getting-started/updates/#watchtower # # watchtower: # restart: unless-stopped diff --git a/docker/examples/macos/docker-compose.yml b/docker/examples/macos/docker-compose.yml index a0d1adfc8..f090a958e 100644 --- a/docker/examples/macos/docker-compose.yml +++ b/docker/examples/macos/docker-compose.yml @@ -10,8 +10,7 @@ version: '3.5' # Your files and passwords will be transmitted in clear text otherwise. # # DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # Start | docker-compose up -d # Stop | docker-compose stop # Update | docker-compose pull @@ -26,10 +25,13 @@ version: '3.5' # Reindex | docker-compose exec photoprism photoprism index -f # Import | docker-compose exec photoprism photoprism import # +# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples. +# # To search originals for faces without a complete rescan: # docker-compose exec photoprism photoprism faces index services: + # REQUIRED: PhotoPrism Application Server photoprism: # Use photoprism/photoprism:preview for testing preview builds: image: photoprism/photoprism:latest @@ -62,11 +64,11 @@ services: PHOTOPRISM_DARKTABLE_PRESETS: "false" # Enables Darktable presets and disables concurrent RAW conversion PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive (requires TensorFlow) PHOTOPRISM_UPLOAD_NSFW: "true" # Allow uploads that MAY be offensive - PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB (or MySQL) instead of SQLite for improved performance - PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) - PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database schema name - PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database user name - PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database user password + PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB or MySQL database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB or MySQL database user password PHOTOPRISM_SITE_TITLE: "PhotoPrism" PHOTOPRISM_SITE_CAPTION: "Browse Your Life" PHOTOPRISM_SITE_DESCRIPTION: "" @@ -85,6 +87,8 @@ services: # Cache, session, thumbnail, and sidecar files will be created in the *storage* folder (never remove): - "./storage:/photoprism/storage" + # RECOMMENDED: MariaDB Server, a MySQL-compatible Database + # see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: restart: unless-stopped image: mariadb:10.6 @@ -101,6 +105,7 @@ services: MYSQL_PASSWORD: insecure # OPTIONAL: Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available. + # see https://docs.photoprism.org/getting-started/updates/#watchtower # # watchtower: # restart: unless-stopped diff --git a/docker/examples/scheduler/docker-compose.yml b/docker/examples/scheduler/docker-compose.yml index f83f359d6..20422f44c 100644 --- a/docker/examples/scheduler/docker-compose.yml +++ b/docker/examples/scheduler/docker-compose.yml @@ -12,8 +12,7 @@ version: '3.5' # Your files and passwords will be transmitted in clear text otherwise. # # DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # Start | docker-compose up -d # Stop | docker-compose stop # Update | docker-compose pull @@ -28,13 +27,16 @@ version: '3.5' # Reindex | docker-compose exec photoprism photoprism index -f # Import | docker-compose exec photoprism photoprism import # +# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples. +# # To search originals for faces without a complete rescan: # docker-compose exec photoprism photoprism faces index # # NOTE: All commands may have to be prefixed with "sudo" when not running as root. -# This will point the home directory placeholder ~ to /root in volume mounts. +# This will point the home directory placeholder ~ to /root in volume mounts. services: + # REQUIRED: PhotoPrism Application Server photoprism: # Use photoprism/photoprism:preview for testing preview builds: image: photoprism/photoprism:latest @@ -71,11 +73,11 @@ services: PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive (requires TensorFlow) PHOTOPRISM_UPLOAD_NSFW: "true" # Allow uploads that MAY be offensive # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that doesn't require a server - PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB (or MySQL) instead of SQLite for improved performance - PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) - PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database schema name - PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database user name - PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database user password + PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB or MySQL database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB or MySQL database user password PHOTOPRISM_SITE_TITLE: "PhotoPrism" PHOTOPRISM_SITE_CAPTION: "Browse Your Life" PHOTOPRISM_SITE_DESCRIPTION: "" @@ -99,6 +101,8 @@ services: # Cache, session, thumbnail, and sidecar files will be created in the *storage* folder (never remove): - "./storage:/photoprism/storage" + # RECOMMENDED: MariaDB Server, a MySQL-compatible Database + # see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: restart: unless-stopped image: mariadb:10.6 @@ -124,6 +128,7 @@ services: - "./jobs.ini:/etc/ofelia/config.ini" # OPTIONAL: Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available. + # see https://docs.photoprism.org/getting-started/updates/#watchtower # # watchtower: # restart: unless-stopped diff --git a/docker/examples/sqlite/docker-compose.yml b/docker/examples/sqlite/docker-compose.yml index e6dece500..e9adef151 100644 --- a/docker/examples/sqlite/docker-compose.yml +++ b/docker/examples/sqlite/docker-compose.yml @@ -10,8 +10,7 @@ version: '3.5' # Your files and passwords will be transmitted in clear text otherwise. # # DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # Start | docker-compose up -d # Stop | docker-compose stop # Update | docker-compose pull @@ -26,13 +25,16 @@ version: '3.5' # Reindex | docker-compose exec photoprism photoprism index -f # Import | docker-compose exec photoprism photoprism import # +# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples. +# # To search originals for faces without a complete rescan: # docker-compose exec photoprism photoprism faces index # # NOTE: All commands may have to be prefixed with "sudo" when not running as root. -# This will point the home directory placeholder ~ to /root in volume mounts. +# This will point the home directory placeholder ~ to /root in volume mounts. services: + # REQUIRED: PhotoPrism Application Server photoprism: # Use photoprism/photoprism:preview for testing preview builds: image: photoprism/photoprism:latest @@ -90,6 +92,7 @@ services: - "./storage:/photoprism/storage" # OPTIONAL: Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available. + # see https://docs.photoprism.org/getting-started/updates/#watchtower # # watchtower: # restart: unless-stopped diff --git a/docker/examples/windows/docker-compose.yml b/docker/examples/windows/docker-compose.yml index 8dcba23a1..b90bf704b 100644 --- a/docker/examples/windows/docker-compose.yml +++ b/docker/examples/windows/docker-compose.yml @@ -13,8 +13,7 @@ version: '3.5' # Your files and passwords will be transmitted in clear text otherwise. # # DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------------------- +# -------------------------------------------------------------------------- # Start | docker-compose up -d # Stop | docker-compose stop # Update | docker-compose pull @@ -29,10 +28,13 @@ version: '3.5' # Reindex | docker-compose exec photoprism photoprism index -f # Import | docker-compose exec photoprism photoprism import # +# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples. +# # To search originals for faces without a complete rescan: # docker-compose exec photoprism photoprism faces index services: + # REQUIRED: PhotoPrism Application Server photoprism: # Use photoprism/photoprism:preview for testing preview builds: image: photoprism/photoprism:latest @@ -65,11 +67,11 @@ services: PHOTOPRISM_DARKTABLE_PRESETS: "false" # Enables Darktable presets and disables concurrent RAW conversion PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive (requires TensorFlow) PHOTOPRISM_UPLOAD_NSFW: "true" # Allow uploads that MAY be offensive - PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB (or MySQL) instead of SQLite for improved performance - PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server hostname (:port is optional) - PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database schema name - PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database user name - PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database user password + PHOTOPRISM_DATABASE_DRIVER: "mysql" # Use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB or MySQL database server hostname (:port is optional) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB or MySQL database user password PHOTOPRISM_SITE_TITLE: "PhotoPrism" PHOTOPRISM_SITE_CAPTION: "Browse Your Life" PHOTOPRISM_SITE_DESCRIPTION: "" @@ -87,6 +89,8 @@ services: # Cache, session, thumbnail, and sidecar files will be created in the *storage* folder (never remove): - "./storage:/photoprism/storage" + # RECOMMENDED: MariaDB Server, a MySQL-compatible Database + # see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql mariadb: restart: unless-stopped image: mariadb:10.6 @@ -103,6 +107,7 @@ services: MYSQL_PASSWORD: insecure # OPTIONAL: Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available. + # see https://docs.photoprism.org/getting-started/updates/#watchtower # # watchtower: # restart: unless-stopped