From 7afffe18090c2da68085dbe18e223e379594d416 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Sat, 29 Mar 2025 04:24:47 +0100 Subject: [PATCH] Setup: Improve compose.yaml inline documentation #4051 Signed-off-by: Michael Mayer --- setup/docker/arm64/compose.yaml | 8 ++++---- setup/docker/armv7/compose.yaml | 8 ++++---- setup/docker/cloud/compose.yaml | 2 +- setup/docker/compose.yaml | 8 ++++---- setup/docker/macos/compose.yaml | 8 ++++---- setup/docker/nvidia/compose.yaml | 8 ++++---- setup/docker/scheduler/compose.yaml | 8 ++++---- setup/docker/sqlite/compose.yaml | 2 +- setup/docker/windows/compose.yaml | 6 +++--- setup/podman/docker-compose.yml | 8 ++++---- 10 files changed, 33 insertions(+), 33 deletions(-) diff --git a/setup/docker/arm64/compose.yaml b/setup/docker/arm64/compose.yaml index 69d8bd4c5..2f89934e8 100644 --- a/setup/docker/arm64/compose.yaml +++ b/setup/docker/arm64/compose.yaml @@ -87,9 +87,9 @@ services: # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite 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_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description PHOTOPRISM_SITE_AUTHOR: "" # meta site author @@ -97,7 +97,7 @@ services: # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) - ## Run/install on first startup (options: update, gpu, tensorflow, davfs, clean): + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: # PHOTOPRISM_INIT: "update clean" ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): # PHOTOPRISM_UID: 1000 diff --git a/setup/docker/armv7/compose.yaml b/setup/docker/armv7/compose.yaml index 9a9b8ffd4..488aa6b52 100644 --- a/setup/docker/armv7/compose.yaml +++ b/setup/docker/armv7/compose.yaml @@ -81,9 +81,9 @@ services: # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite 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_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description PHOTOPRISM_SITE_AUTHOR: "" # meta site author @@ -91,7 +91,7 @@ services: # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) - ## Run/install on first startup (options: update, gpu, tensorflow, davfs, clean): + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: # PHOTOPRISM_INIT: "update clean" ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): # PHOTOPRISM_UID: 1000 diff --git a/setup/docker/cloud/compose.yaml b/setup/docker/cloud/compose.yaml index f80f39700..305b5ab90 100644 --- a/setup/docker/cloud/compose.yaml +++ b/setup/docker/cloud/compose.yaml @@ -163,7 +163,7 @@ services: # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) - ## Run/install on first startup (options: update, gpu, tensorflow, davfs, clean): + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: PHOTOPRISM_INIT: "update tensorflow clean" working_dir: "/photoprism" # do not change or remove ## Storage Folders: "~" is a shortcut for your home directory, "." for the current directory diff --git a/setup/docker/compose.yaml b/setup/docker/compose.yaml index 5e79a60dc..2f6ec8d9c 100644 --- a/setup/docker/compose.yaml +++ b/setup/docker/compose.yaml @@ -77,9 +77,9 @@ services: # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite 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_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description PHOTOPRISM_SITE_AUTHOR: "" # meta site author @@ -87,7 +87,7 @@ services: # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) - ## Run/install on first startup (options: update https gpu ffmpeg tensorflow davfs clitools clean): + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: # PHOTOPRISM_INIT: "https gpu tensorflow" ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): # PHOTOPRISM_UID: 1000 diff --git a/setup/docker/macos/compose.yaml b/setup/docker/macos/compose.yaml index 90c6edd8e..4e6274013 100644 --- a/setup/docker/macos/compose.yaml +++ b/setup/docker/macos/compose.yaml @@ -71,9 +71,9 @@ services: PHOTOPRISM_UPLOAD_NSFW: "true" # allows uploads that MAY be offensive (no effect without TensorFlow) PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite 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_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description PHOTOPRISM_SITE_AUTHOR: "" # meta site author @@ -81,7 +81,7 @@ services: # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) - ## Run/install on first startup (options: update https gpu ffmpeg tensorflow davfs clitools clean): + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: # PHOTOPRISM_INIT: "https gpu tensorflow" ## Storage Folders: "~" is a shortcut for your home directory, "." for the current directory volumes: diff --git a/setup/docker/nvidia/compose.yaml b/setup/docker/nvidia/compose.yaml index b02230e38..428e5cc51 100644 --- a/setup/docker/nvidia/compose.yaml +++ b/setup/docker/nvidia/compose.yaml @@ -81,9 +81,9 @@ services: # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite 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_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description PHOTOPRISM_SITE_AUTHOR: "" # meta site author PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" @@ -93,7 +93,7 @@ services: # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) NVIDIA_VISIBLE_DEVICES: "all" NVIDIA_DRIVER_CAPABILITIES: "compute,video,utility" - ## Run/install on first startup: + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: PHOTOPRISM_INIT: "tensorflow" ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): # PHOTOPRISM_UID: 1000 diff --git a/setup/docker/scheduler/compose.yaml b/setup/docker/scheduler/compose.yaml index 55325bcac..cb9cab0b8 100644 --- a/setup/docker/scheduler/compose.yaml +++ b/setup/docker/scheduler/compose.yaml @@ -75,9 +75,9 @@ services: # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite 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_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description PHOTOPRISM_SITE_AUTHOR: "" # meta site author @@ -85,7 +85,7 @@ services: # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) - ## Run/install on first startup (options: update https gpu ffmpeg tensorflow davfs clitools clean): + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: # PHOTOPRISM_INIT: "https gpu tensorflow" ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): # PHOTOPRISM_UID: 1000 diff --git a/setup/docker/sqlite/compose.yaml b/setup/docker/sqlite/compose.yaml index 7de77ce81..acd53ac99 100644 --- a/setup/docker/sqlite/compose.yaml +++ b/setup/docker/sqlite/compose.yaml @@ -78,7 +78,7 @@ services: # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) - ## Run/install on first startup (options: update https gpu ffmpeg tensorflow davfs clitools clean): + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: # PHOTOPRISM_INIT: "https gpu tensorflow" ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): # PHOTOPRISM_UID: 1000 diff --git a/setup/docker/windows/compose.yaml b/setup/docker/windows/compose.yaml index 2156e43ac..a971a7fff 100644 --- a/setup/docker/windows/compose.yaml +++ b/setup/docker/windows/compose.yaml @@ -78,9 +78,9 @@ services: PHOTOPRISM_UPLOAD_NSFW: "true" # allows uploads that MAY be offensive (no effect without TensorFlow) PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite 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_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description PHOTOPRISM_SITE_AUTHOR: "" # meta site author diff --git a/setup/podman/docker-compose.yml b/setup/podman/docker-compose.yml index e54b4b325..42c0f010a 100644 --- a/setup/podman/docker-compose.yml +++ b/setup/podman/docker-compose.yml @@ -88,9 +88,9 @@ services: # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that does not require a separate database server PHOTOPRISM_DATABASE_DRIVER: "mysql" # MariaDB 10.5.12+ (MySQL successor) offers significantly better performance compared to SQLite 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_NAME: "photoprism" # MariaDB database, see MARIADB_DATABASE in the mariadb service + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database username, must be the same as MARIADB_USER + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database password, must be the same as MARIADB_PASSWORD PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description PHOTOPRISM_SITE_AUTHOR: "" # meta site author @@ -98,7 +98,7 @@ services: # PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) # PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840) # PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50) - ## Run/install on first startup (options: update https gpu ffmpeg tensorflow davfs clitools clean): + ## Optional commands to run during the first start, see https://github.com/photoprism/photoprism/blob/develop/scripts/dist/Makefile: # PHOTOPRISM_INIT: "https gpu tensorflow" ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): # PHOTOPRISM_UID: 1000