From 551f18b8b1f9e18fe5d7e97cb0b24aaf2643605d Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 28 Dec 2020 11:41:57 +0100 Subject: [PATCH] Config: Improve docker-compose.yml examples #535 #666 Signed-off-by: Michael Mayer --- docker/examples/arm64/docker-compose.yml | 30 ++++--- docker/examples/docker-compose.yml | 24 +++-- .../examples/healthcheck/docker-compose.yml | 90 ------------------- docker/examples/macos/docker-compose.yml | 24 +++-- docker/examples/sqlite/docker-compose.yml | 22 ++--- docker/examples/windows/docker-compose.yml | 26 ++++-- 6 files changed, 83 insertions(+), 133 deletions(-) delete mode 100644 docker/examples/healthcheck/docker-compose.yml diff --git a/docker/examples/arm64/docker-compose.yml b/docker/examples/arm64/docker-compose.yml index a7b215775..4d3f16359 100644 --- a/docker/examples/arm64/docker-compose.yml +++ b/docker/examples/arm64/docker-compose.yml @@ -8,26 +8,28 @@ version: '3.5' # Please run behind a reverse proxy like Caddy, Traefik or Nginx if you need HTTPS / SSL support # e.g. when running PhotoPrism on a public server outside your home network. # -# Usage: docker-compose up +# DOCKER COMPOSE COMMAND REFERENCE +# ---------------------------------------------------------- +# Update: docker-compose pull photoprism +# Stop: docker-compose stop photoprism +# Start: docker-compose up -d photoprism +# Logs: docker-compose logs --tail=20 +# Terminal: docker-compose exec photoprism bash +# Help: docker-compose exec photoprism photoprism help +# Config: docker-compose exec photoprism photoprism config services: photoprism: image: photoprism/photoprism-arm64:latest - # Only enable restart and healthcheck once your installation is properly - # configured as it otherwise gets stuck in a restart loop: + # Only enable automatic restarts once your installation is properly + # configured as it otherwise may get stuck in a restart loop: + # https://docs.photoprism.org/getting-started/faq/#why-is-photoprism-getting-stuck-in-a-restart-loop # restart: unless-stopped security_opt: - seccomp:unconfined - apparmor:unconfined ports: - 2342:2342 # [local port]:[container port] - # Uncomment the following lines to enable regular health checks (causes automatic restarts, be careful): - # healthcheck: - # test: ["CMD", "photoprism", "status"] - # interval: 60s - # timeout: 15s - # retries: 5 - # Run "photoprism help" and "photoprism config" in a terminal too see all config options and current values: environment: PHOTOPRISM_HTTP_PORT: 2342 PHOTOPRISM_ADMIN_PASSWORD: "insecure" # PLEASE CHANGE: This is your initial admin password @@ -71,12 +73,14 @@ services: mariadb: image: arm64v8/mariadb:10.5 restart: unless-stopped + security_opt: + - seccomp:unconfined + - apparmor:unconfined command: mysqld --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=50 - volumes: - # Permanent storage for index database files (DON'T REMOVE): + volumes: # Don't remove permanent storage for index database files! - "./storage/mariadb:/var/lib/mysql" environment: - MYSQL_ROOT_PASSWORD: insecure + MYSQL_ROOT_PASSWORD: please_change MYSQL_DATABASE: photoprism MYSQL_USER: photoprism MYSQL_PASSWORD: insecure diff --git a/docker/examples/docker-compose.yml b/docker/examples/docker-compose.yml index 7cd4e061f..4c8ee06aa 100644 --- a/docker/examples/docker-compose.yml +++ b/docker/examples/docker-compose.yml @@ -8,20 +8,28 @@ version: '3.5' # Please run behind a reverse proxy like Caddy, Traefik or Nginx if you need HTTPS / SSL support # e.g. when running PhotoPrism on a public server outside your home network. # -# Usage: docker-compose up +# DOCKER COMPOSE COMMAND REFERENCE +# ---------------------------------------------------------- +# Update: docker-compose pull photoprism +# Stop: docker-compose stop photoprism +# Start: docker-compose up -d photoprism +# Logs: docker-compose logs --tail=20 +# Terminal: docker-compose exec photoprism bash +# Help: docker-compose exec photoprism photoprism help +# Config: docker-compose exec photoprism photoprism config services: photoprism: image: photoprism/photoprism:latest - # Only enable enable restart and healthcheck once your installation is properly - # configured as it otherwise gets stuck in a restart loop: + # Only enable automatic restarts once your installation is properly + # configured as it otherwise may get stuck in a restart loop: + # https://docs.photoprism.org/getting-started/faq/#why-is-photoprism-getting-stuck-in-a-restart-loop # restart: unless-stopped security_opt: - seccomp:unconfined - apparmor:unconfined ports: - 2342:2342 # [local port]:[container port] - # Run "photoprism help" and "photoprism config" in a terminal too see all config options and current values: environment: PHOTOPRISM_HTTP_PORT: 2342 PHOTOPRISM_ADMIN_PASSWORD: "insecure" # PLEASE CHANGE: This is your initial admin password @@ -66,12 +74,14 @@ services: mariadb: image: mariadb:10.5 restart: unless-stopped + security_opt: + - seccomp:unconfined + - apparmor:unconfined command: mysqld --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=50 - volumes: - # Permanent storage for index database files (DON'T REMOVE): + volumes: # Don't remove permanent storage for index database files! - "./storage/mariadb:/var/lib/mysql" environment: - MYSQL_ROOT_PASSWORD: insecure + MYSQL_ROOT_PASSWORD: please_change MYSQL_DATABASE: photoprism MYSQL_USER: photoprism MYSQL_PASSWORD: insecure diff --git a/docker/examples/healthcheck/docker-compose.yml b/docker/examples/healthcheck/docker-compose.yml deleted file mode 100644 index d0bc2e376..000000000 --- a/docker/examples/healthcheck/docker-compose.yml +++ /dev/null @@ -1,90 +0,0 @@ -version: '3.5' - -# Example Docker Compose config file for PhotoPrism (Linux / AMD64) -# -# Documentation : https://docs.photoprism.org/getting-started/docker-compose/ -# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ -# -# Please run behind a reverse proxy like Caddy, Traefik or Nginx if you need HTTPS / SSL support -# e.g. when running PhotoPrism on a public server outside your home network. -# -# Usage: docker-compose up - -services: - photoprism: - image: photoprism/photoprism:latest - # Only enable restart and healthcheck once your installation is properly - # configured as it otherwise gets stuck in a restart loop: - restart: unless-stopped - healthcheck: - test: ["CMD", "photoprism", "status"] - interval: 60s - timeout: 15s - retries: 5 - security_opt: - - seccomp:unconfined - - apparmor:unconfined - ports: - - 2342:2342 # [local port]:[container port] - # Run "photoprism help" and "photoprism config" in a terminal too see all config options and current values: - environment: - PHOTOPRISM_HTTP_PORT: 2342 - PHOTOPRISM_ADMIN_PASSWORD: "insecure" # PLEASE CHANGE: This is your initial admin password - PHOTOPRISM_DEBUG: "false" # Run in debug mode (shows additional log messages) - PHOTOPRISM_PUBLIC: "false" # No authentication required (disables password protection) - PHOTOPRISM_READONLY: "false" # Don't modify originals directory (reduced functionality) - PHOTOPRISM_EXPERIMENTAL: "false" # Enable experimental features - PHOTOPRISM_DISABLE_WEBDAV: "false" # Disable built-in WebDAV server - PHOTOPRISM_DISABLE_SETTINGS: "false" # Users can not view or change settings - PHOTOPRISM_DISABLE_TENSORFLOW: "false" # Don't use TensorFlow for image classification - 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_SITE_URL: "http://localhost:2342/" # Public PhotoPrism URL - PHOTOPRISM_SITE_TITLE: "PhotoPrism" - PHOTOPRISM_SITE_CAPTION: "Browse Your Life" - PHOTOPRISM_SITE_DESCRIPTION: "" - PHOTOPRISM_SITE_AUTHOR: "" - # You may optionally set a user / group id using environment variables if your Docker version or NAS does not - # support this natively (see next example): - # UID: 1000 - # GID: 1000 - # UMASK: 0000 - # Uncomment and edit the following line to set a specific user / group id (native): - # user: "1000:1000" - volumes: - # Your photo and video files ([local path]:[container path]): - - "~/Pictures:/photoprism/originals" - # Multiple folders can be indexed by mounting them as sub-folders of /photoprism/originals: - # - "/mnt/Family:/photoprism/originals/Family" # [folder_1]:/photoprism/originals/[folder_1] - # - "/mnt/Friends:/photoprism/originals/Friends" # [folder_2]:/photoprism/originals/[folder_2] - # Mounting an import folder is optional (see docs): - # - "~/Import:/photoprism/import" - # Permanent storage for settings, index & sidecar files (DON'T REMOVE): - - "./storage:/photoprism/storage" - - mariadb: - image: mariadb:10.5 - restart: unless-stopped - command: mysqld --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=50 - volumes: - # Permanent storage for index database files (DON'T REMOVE): - - "./storage/mariadb:/var/lib/mysql" - environment: - MYSQL_ROOT_PASSWORD: insecure - MYSQL_DATABASE: photoprism - MYSQL_USER: photoprism - MYSQL_PASSWORD: insecure - -# Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available: -# -# watchtower: -# image: containrrr/watchtower -# restart: unless-stopped -# volumes: -# - "/var/run/docker.sock:/var/run/docker.sock" diff --git a/docker/examples/macos/docker-compose.yml b/docker/examples/macos/docker-compose.yml index 30dfbee95..3ad5a585f 100644 --- a/docker/examples/macos/docker-compose.yml +++ b/docker/examples/macos/docker-compose.yml @@ -8,21 +8,29 @@ version: '3.5' # Please run behind a reverse proxy like Caddy, Traefik or Nginx if you need HTTPS / SSL support # e.g. when running PhotoPrism on a public server outside your home network. # -# Usage: docker-compose up +# DOCKER COMPOSE COMMAND REFERENCE +# ---------------------------------------------------------- +# Update: docker-compose pull photoprism +# Stop: docker-compose stop photoprism +# Start: docker-compose up -d photoprism +# Logs: docker-compose logs --tail=20 +# Terminal: docker-compose exec photoprism bash +# Help: docker-compose exec photoprism photoprism help +# Config: docker-compose exec photoprism photoprism config services: photoprism: # Use photoprism/photoprism-arm64:latest instead if you own a new ARM-based Mac: image: photoprism/photoprism:latest - # Only enable restart and healthcheck once your installation is properly - # configured as it otherwise gets stuck in a restart loop: + # Only enable automatic restarts once your installation is properly + # configured as it otherwise may get stuck in a restart loop: + # https://docs.photoprism.org/getting-started/faq/#why-is-photoprism-getting-stuck-in-a-restart-loop # restart: unless-stopped security_opt: - seccomp:unconfined - apparmor:unconfined ports: - 2342:2342 # [local port]:[container port] - # Run "photoprism help" and "photoprism config" in a terminal too see all config options and current values: environment: PHOTOPRISM_HTTP_PORT: 2342 PHOTOPRISM_ADMIN_PASSWORD: "insecure" # PLEASE CHANGE: This is your initial admin password @@ -59,12 +67,14 @@ services: mariadb: image: mariadb:10.5 restart: unless-stopped + security_opt: + - seccomp:unconfined + - apparmor:unconfined command: mysqld --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=50 - volumes: - # Permanent storage for index database files (DON'T REMOVE): + volumes: # Don't remove permanent storage for index database files! - "mariadb_data:/var/lib/mysql" environment: - MYSQL_ROOT_PASSWORD: insecure + MYSQL_ROOT_PASSWORD: please_change MYSQL_DATABASE: photoprism MYSQL_USER: photoprism MYSQL_PASSWORD: insecure diff --git a/docker/examples/sqlite/docker-compose.yml b/docker/examples/sqlite/docker-compose.yml index 82ea33f97..c0375b514 100644 --- a/docker/examples/sqlite/docker-compose.yml +++ b/docker/examples/sqlite/docker-compose.yml @@ -8,26 +8,28 @@ version: '3.5' # Please run behind a reverse proxy like Caddy, Traefik or Nginx if you need HTTPS / SSL support # e.g. when running PhotoPrism on a public server outside your home network. # -# Usage: docker-compose up +# DOCKER COMPOSE COMMAND REFERENCE +# ---------------------------------------------------------- +# Update: docker-compose pull photoprism +# Stop: docker-compose stop photoprism +# Start: docker-compose up -d photoprism +# Logs: docker-compose logs --tail=20 +# Terminal: docker-compose exec photoprism bash +# Help: docker-compose exec photoprism photoprism help +# Config: docker-compose exec photoprism photoprism config services: photoprism: image: photoprism/photoprism:latest - # Only enable restart and healthcheck once your installation is properly - # configured as it otherwise gets stuck in a restart loop: + # Only enable automatic restarts once your installation is properly + # configured as it otherwise may get stuck in a restart loop: + # https://docs.photoprism.org/getting-started/faq/#why-is-photoprism-getting-stuck-in-a-restart-loop # restart: unless-stopped security_opt: - seccomp:unconfined - apparmor:unconfined ports: - 2342:2342 # [local port]:[container port] - # Uncomment the following lines to enable regular health checks (causes automatic restarts, be careful): - # healthcheck: - # test: ["CMD", "photoprism", "status"] - # interval: 60s - # timeout: 15s - # retries: 5 - # Run "photoprism help" and "photoprism config" in a terminal too see all config options and current values: environment: PHOTOPRISM_HTTP_PORT: 2342 PHOTOPRISM_ADMIN_PASSWORD: "insecure" # PLEASE CHANGE: This is your initial admin password diff --git a/docker/examples/windows/docker-compose.yml b/docker/examples/windows/docker-compose.yml index 18c744014..a4eba0605 100644 --- a/docker/examples/windows/docker-compose.yml +++ b/docker/examples/windows/docker-compose.yml @@ -11,14 +11,26 @@ version: '3.5' # Please run behind a reverse proxy like Caddy, Traefik or Nginx if you need HTTPS / SSL support # e.g. when running PhotoPrism on a public server outside your home network. # -# Usage: docker-compose up +# DOCKER COMPOSE COMMAND REFERENCE +# ---------------------------------------------------------- +# Update: docker-compose pull photoprism +# Stop: docker-compose stop photoprism +# Start: docker-compose up -d photoprism +# Logs: docker-compose logs --tail=20 +# Terminal: docker-compose exec photoprism bash +# Help: docker-compose exec photoprism photoprism help +# Config: docker-compose exec photoprism photoprism config services: photoprism: image: photoprism/photoprism:latest - # Only enable restart and healthcheck once your installation is properly - # configured as it otherwise gets stuck in a restart loop: + # Only enable automatic restarts once your installation is properly + # configured as it otherwise may get stuck in a restart loop: + # https://docs.photoprism.org/getting-started/faq/#why-is-photoprism-getting-stuck-in-a-restart-loop # restart: unless-stopped + security_opt: + - seccomp:unconfined + - apparmor:unconfined ports: - 2342:2342 # [local port]:[container port] environment: @@ -55,12 +67,14 @@ services: mariadb: image: mariadb:10.5 restart: unless-stopped + security_opt: + - seccomp:unconfined + - apparmor:unconfined command: mysqld --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=50 - volumes: - # Permanent storage for index database files (DON'T REMOVE): + volumes: # Don't remove permanent storage for index database files! - "mariadb_data:/var/lib/mysql" environment: - MYSQL_ROOT_PASSWORD: insecure + MYSQL_ROOT_PASSWORD: please_change MYSQL_DATABASE: photoprism MYSQL_USER: photoprism MYSQL_PASSWORD: insecure