Setup: Rename docker-compose.yml to compose.yaml #4591

Signed-off-by: Michael Mayer <michael@photoprism.app>

setup/docker/arm64/README

@@ -19,7 +19,7 @@ as for regular Linux servers apply:
 
   https://docs.photoprism.app/getting-started/docker-compose/
 
-Existing users are advised to check their "docker-compose.yml" against our examples
+Existing users are advised to check their "compose.yaml" against our examples
 at <dl.photoprism.app/docker> from time to time in case there are new configuration
 options or other improvements. Update instructions can be found at the bottom of
 this README file.
@@ -73,7 +73,7 @@ It may also help to set the DOCKER_DEFAULT_PLATFORM environment variable to
   temporarily needs more memory to process large files
 - High-resolution panoramic images may require additional swap space and/or
   physical memory above the recommended minimum
-- We recommend disabling kernel security in your docker-compose.yml, especially
+- We recommend disabling kernel security in your compose.yaml, especially
   if you do not have experience with the configuration:
   ```
   photoprism:
@@ -91,7 +91,7 @@ If your server runs out of memory, the index is frequently locked, or other
 system resources are running low:
 
 - Try reducing the number of workers by setting PHOTOPRISM_WORKERS to a
-  reasonably small value in docker-compose.yml, depending on the performance
+  reasonably small value in compose.yaml, depending on the performance
   of your device or cloud server:
 
   https://docs.photoprism.app/getting-started/config-options/
@@ -120,7 +120,7 @@ transcoding is generally slow.
 
 ### Getting Updates ###
 
-Open a terminal and change to the folder where the "docker-compose.yml" file
+Open a terminal and change to the folder where the "compose.yaml" file
 was saved. Now run the following commands to download the most recent image
 from Docker Hub and restart your instance in the background:
 

setup/docker/arm64/compose.yaml

@@ -5,7 +5,7 @@
 #   An "exec format" error will occur otherwise.
 # - Try explicitly pulling the ARM64 version if you've booted your device with the "arm_64bit=1" flag and you see
 #   the "no matching manifest" error on Raspberry Pi OS (Raspbian). See documentation for details.
-# - Use https://dl.photoprism.app/docker/armv7/docker-compose.yml to run PhotoPrism and MariaDB on ARMv7-based devices
+# - Use https://dl.photoprism.app/docker/armv7/compose.yaml to run PhotoPrism and MariaDB on ARMv7-based devices
 #   as well as Raspberry Pi OS (Raspbian) installations without 64-bit support.
 # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected
 #   restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files.

setup/docker/armv7/README

@@ -22,7 +22,7 @@ instructions as for regular Linux servers apply:
 
 Please pay close attention to changed directory and environment variable names!
 
-Existing users are advised to check their "docker-compose.yml" against our examples
+Existing users are advised to check their "compose.yaml" against our examples
 at <dl.photoprism.app/docker> from time to time in case there are new configuration
 options or other improvements. Update instructions can be found at the bottom of
 this README file.
@@ -43,7 +43,7 @@ this README file.
   temporarily needs more memory to process large files
 - High-resolution panoramic images may require additional swap space and/or
   physical memory above the recommended minimum
-- We recommend disabling kernel security in your docker-compose.yml, especially
+- We recommend disabling kernel security in your compose.yaml, especially
   if you do not have experience with the configuration:
   ```
   photoprism:
@@ -61,7 +61,7 @@ If your server runs out of memory, the index is frequently locked, or other
 system resources are running low:
 
 - Try reducing the number of workers by setting PHOTOPRISM_WORKERS to a reasonably
-  small value in docker-compose.yml, depending on the performance of your device
+  small value in compose.yaml, depending on the performance of your device
   or cloud server:
 
   https://docs.photoprism.app/getting-started/config-options/
@@ -79,7 +79,7 @@ solve them:
 
 ### Getting Updates ###
 
-Open a terminal and change to the folder where the "docker-compose.yml" file
+Open a terminal and change to the folder where the "compose.yaml" file
 was saved. Now run the following commands to download the most recent image
 from Docker Hub and restart your instance in the background:
 

setup/docker/armv7/compose.yaml

@@ -1,7 +1,7 @@
 # Example Docker Compose config file for PhotoPrism (ARMv7-based, 32-bit devices)
 #
 # Note:
-# - Use https://dl.photoprism.app/docker/arm64/docker-compose.yml for running PhotoPrism on ARM64-based (64-bit) devices.
+# - Use https://dl.photoprism.app/docker/arm64/compose.yaml for running PhotoPrism on ARM64-based (64-bit) devices.
 # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected
 #   restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files.
 # - In case you see Docker errors related to "cgroups", try adding the following parameters to /boot/firmware/cmdline.txt

setup/docker/cloud/README.txt

@@ -43,7 +43,7 @@ Data and all config files related to PhotoPrism can be found in
 
 The main docker compose config file for changing config options is
 
-  /opt/photoprism/docker-compose.yml
+  /opt/photoprism/compose.yaml
 
 The server is running as "photoprism" (UID 1000) by default. There's no need
 to change defaults unless you experience conflicts with other services running
@@ -78,12 +78,12 @@ You may add a static DNS entry (on DigitalOcean go to Networking > Domains)
 for this, or use a Dynamic DNS service of your choice.
 
 Once your server has a public domain name, please disable the self-signed
-certificate and enable domain based routing in docker-compose.yml and
+certificate and enable domain based routing in compose.yaml and
 traefik.yaml (see inline instructions in !! UPPERCASE !!):
 
   ssh root@<YOUR SERVER IP>
   cd /opt/photoprism
-  nano docker-compose.yml
+  nano compose.yaml
   nano traefik.yaml
 
 Then restart services in a terminal for the changes to take effect:

setup/docker/cloud/compose.yaml

@@ -29,7 +29,7 @@
 #
 #  The main docker compose config file for changing config options is
 #
-#    /opt/photoprism/docker-compose.yml
+#    /opt/photoprism/compose.yaml
 #
 #  The server is running as "photoprism" (UID 1000) by default. There's no need
 #  to change defaults unless you experience conflicts with other services running
@@ -81,12 +81,12 @@
 #  ------------------------------------------------------------------------
 #
 #  If your server has a public domain name, please disable the self-signed
-#  certificate and enable domain based routing in docker-compose.yml and
+#  certificate and enable domain based routing in compose.yaml and
 #  traefik.yaml (see inline instructions in !! UPPERCASE !!)
 #
 #    ssh root@<YOUR SERVER IP>
 #    cd /opt/photoprism
-#    nano docker-compose.yml
+#    nano compose.yaml
 #    nano traefik.yaml
 #    docker compose stop
 #    docker compose up -d

setup/docker/cloud/digitalocean/README.md

@@ -44,7 +44,7 @@ To edit the main config file containing services, storage paths, and basic setti
 
 ```
 cd /opt/photoprism
-nano docker-compose.yml
+nano compose.yaml
 ```
 
 Remember to restart services for changes to take effect:
@@ -62,12 +62,12 @@ To get an official, free HTTPS certificate from Let's Encrypt, your server needs
 
 You may add a static DNS entry (on DigitalOcean go to Networking > Domains) for this, or use a Dynamic DNS service of your choice.
 
-Once your server has a public domain name, please disable the self-signed certificate and enable domain based routing in docker-compose.yml and traefik.yaml (see inline instructions in !! UPPERCASE !!):
+Once your server has a public domain name, please disable the self-signed certificate and enable domain based routing in compose.yaml and traefik.yaml (see inline instructions in !! UPPERCASE !!):
 
 ```
 ssh root@YOUR-SERVER-IP
 cd /opt/photoprism
-nano docker-compose.yml
+nano compose.yaml
 nano traefik.yaml
 ```
 

setup/docker/cloud/setup.sh

@@ -101,10 +101,10 @@ PUBLIC_IP=$(curl -sfSL ifconfig.me)
 echo "Downloading configuration..."
 
 # download service config
-COMPOSE_CONFIG=$(curl -fsSL https://dl.photoprism.app/docker/cloud/docker-compose.yml)
+COMPOSE_CONFIG=$(curl -fsSL https://dl.photoprism.app/docker/cloud/compose.yaml)
 COMPOSE_CONFIG=${COMPOSE_CONFIG//_public_ip_/$PUBLIC_IP}
 COMPOSE_CONFIG=${COMPOSE_CONFIG//$PASSWORD_PLACEHOLDER/$ADMIN_PASSWORD}
-echo "${COMPOSE_CONFIG}" > /opt/photoprism/docker-compose.yml
+echo "${COMPOSE_CONFIG}" > /opt/photoprism/compose.yaml
 curl -fsSL https://dl.photoprism.app/docker/cloud/jobs.ini > /opt/photoprism/jobs.ini
 curl -fsSL https://dl.photoprism.app/docker/cloud/traefik.yaml > /opt/photoprism/traefik.yaml
 

setup/docker/cloud/traefik.yaml

@@ -2,12 +2,12 @@
 #  -------------------------------------------------------------------------
 #
 #  If your server has a public domain name, please disable the self-signed
-#  certificate and enable domain based routing in docker-compose.yml and
+#  certificate and enable domain based routing in compose.yaml and
 #  traefik.yaml (see inline instructions in !! UPPERCASE !!)
 #
 #    ssh root@<YOUR SERVER IP>
 #    cd /opt/photoprism
-#    nano docker-compose.yml
+#    nano compose.yaml
 #    nano traefik.yaml
 #    docker compose stop
 #    docker compose up -d

setup/docker/windows/install.bat

@@ -23,7 +23,7 @@ docker compose version
 echo:
 echo Downloading config files...
 
-curl.exe -s -o docker-compose.yml https://dl.photoprism.app/docker/windows/docker-compose.yml
+curl.exe -s -o compose.yaml https://dl.photoprism.app/docker/windows/compose.yaml
 curl.exe -s -o start.bat https://dl.photoprism.app/docker/windows/start.bat
 curl.exe -s -o stop.bat https://dl.photoprism.app/docker/windows/stop.bat
 curl.exe -s -o uninstall.bat https://dl.photoprism.app/docker/windows/uninstall.bat

setup/docker/windows/uninstall.bat

@@ -17,7 +17,7 @@ docker compose rm -s -v
 echo:
 echo Removing config files...
 
-del docker-compose.yml
+del compose.yaml
 del start.bat
 del stop.bat
 del install.bat