diff --git a/docker/photoprism/arm64/README.md b/docker/examples/arm64/README.md similarity index 100% rename from docker/photoprism/arm64/README.md rename to docker/examples/arm64/README.md diff --git a/docker/photoprism/arm64/docker-compose.yml b/docker/examples/arm64/docker-compose.yml similarity index 92% rename from docker/photoprism/arm64/docker-compose.yml rename to docker/examples/arm64/docker-compose.yml index 67ae0d181..5d34f2df2 100644 --- a/docker/photoprism/arm64/docker-compose.yml +++ b/docker/examples/arm64/docker-compose.yml @@ -13,7 +13,7 @@ version: '3.5' services: photoprism: image: photoprism/photoprism-arm64:latest - # Only enable this option once your installation is properly + # Only enable restart and healthcheck once your installation is properly # configured as it otherwise gets stuck in a restart loop: # restart: unless-stopped security_opt: @@ -34,7 +34,9 @@ services: 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_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 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 @@ -64,7 +66,7 @@ services: # Mounting an import folder is optional (see docs): # - "~/Import:/photoprism/import" # Permanent storage for settings, index & sidecar files (DON'T REMOVE): - - "~/.photoprism:/photoprism/storage" + - "./storage:/photoprism/storage" mariadb: image: mariadb:10.5 @@ -72,7 +74,7 @@ services: 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): - - "~/.photoprism/mariadb:/var/lib/mysql" + - "./storage/mariadb:/var/lib/mysql" environment: MYSQL_ROOT_PASSWORD: insecure MYSQL_DATABASE: photoprism diff --git a/docker/photoprism/docker-compose.yml b/docker/examples/docker-compose.yml similarity index 91% rename from docker/photoprism/docker-compose.yml rename to docker/examples/docker-compose.yml index 4b620113a..7cd4e061f 100644 --- a/docker/photoprism/docker-compose.yml +++ b/docker/examples/docker-compose.yml @@ -13,7 +13,7 @@ version: '3.5' services: photoprism: image: photoprism/photoprism:latest - # Only enable this option once your installation is properly + # Only enable enable restart and healthcheck once your installation is properly # configured as it otherwise gets stuck in a restart loop: # restart: unless-stopped security_opt: @@ -21,12 +21,6 @@ services: - 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 @@ -35,7 +29,9 @@ services: 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 @@ -65,7 +61,7 @@ services: # Mounting an import folder is optional (see docs): # - "~/Import:/photoprism/import" # Permanent storage for settings, index & sidecar files (DON'T REMOVE): - - "~/.photoprism:/photoprism/storage" + - "./storage:/photoprism/storage" mariadb: image: mariadb:10.5 @@ -73,7 +69,7 @@ services: 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): - - "~/.photoprism/mariadb:/var/lib/mysql" + - "./storage/mariadb:/var/lib/mysql" environment: MYSQL_ROOT_PASSWORD: insecure MYSQL_DATABASE: photoprism diff --git a/docker/examples/healthcheck/docker-compose.yml b/docker/examples/healthcheck/docker-compose.yml new file mode 100644 index 000000000..d0bc2e376 --- /dev/null +++ b/docker/examples/healthcheck/docker-compose.yml @@ -0,0 +1,90 @@ +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 new file mode 100644 index 000000000..7bdbbb6c8 --- /dev/null +++ b/docker/examples/macos/docker-compose.yml @@ -0,0 +1,82 @@ +version: '3.5' + +# Example Docker Compose config file for PhotoPrism (MacOS / 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: + # 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: + # 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 + 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: "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: "" + 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): + - "mariadb_data:/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" + +volumes: + mariadb_data: + driver: local diff --git a/docker/photoprism/sqlite/docker-compose.yml b/docker/examples/sqlite/docker-compose.yml similarity index 91% rename from docker/photoprism/sqlite/docker-compose.yml rename to docker/examples/sqlite/docker-compose.yml index 7deb5ca1a..82ea33f97 100644 --- a/docker/photoprism/sqlite/docker-compose.yml +++ b/docker/examples/sqlite/docker-compose.yml @@ -13,7 +13,7 @@ version: '3.5' services: photoprism: image: photoprism/photoprism:latest - # Only enable this option once your installation is properly + # Only enable restart and healthcheck once your installation is properly # configured as it otherwise gets stuck in a restart loop: # restart: unless-stopped security_opt: @@ -34,7 +34,9 @@ services: 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_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 @@ -59,7 +61,7 @@ services: # Mounting the import folder is optional (see docs): # - "~/Import:/photoprism/import" # Permanent storage for settings, index & sidecar files (DON'T REMOVE): - - "~/.photoprism:/photoprism/storage" + - "./storage:/photoprism/storage" # Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available: # diff --git a/docker/photoprism/windows/docker-compose.yml b/docker/examples/windows/docker-compose.yml similarity index 92% rename from docker/photoprism/windows/docker-compose.yml rename to docker/examples/windows/docker-compose.yml index 476da25a7..18c744014 100644 --- a/docker/photoprism/windows/docker-compose.yml +++ b/docker/examples/windows/docker-compose.yml @@ -16,7 +16,7 @@ version: '3.5' services: photoprism: image: photoprism/photoprism:latest - # Only enable this option once your installation is properly + # Only enable restart and healthcheck once your installation is properly # configured as it otherwise gets stuck in a restart loop: # restart: unless-stopped ports: @@ -27,7 +27,9 @@ services: 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 folder; disables import, upload, and delete + 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: "mysql" # Use MariaDB (or MySQL) instead of SQLite for improved performance @@ -48,7 +50,7 @@ services: # Mounting an import folder is optional (see docs): # - "E:/:/photoprism/import" # Permanent storage for settings, index & sidecar files (DON'T REMOVE): - - "~/.photoprism:/photoprism/storage" + - "./storage:/photoprism/storage" mariadb: image: mariadb:10.5