From 0e4c458b90be22e477f239b1b85fff6354bdc61d Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Fri, 1 Jan 2021 19:54:04 +0100 Subject: [PATCH] Config: Update docker-compose.yml examples --- docker/examples/arm64/README.md | 25 +++++++++++++++------ docker/examples/arm64/docker-compose.yml | 26 +++++++++++++++------- docker/examples/docker-compose.yml | 26 +++++++++++++++------- docker/examples/macos/docker-compose.yml | 24 +++++++++++++------- docker/examples/sqlite/docker-compose.yml | 26 +++++++++++++++------- docker/examples/windows/docker-compose.yml | 24 +++++++++++++------- 6 files changed, 104 insertions(+), 47 deletions(-) diff --git a/docker/examples/arm64/README.md b/docker/examples/arm64/README.md index cf5597c69..9c82747b4 100644 --- a/docker/examples/arm64/README.md +++ b/docker/examples/arm64/README.md @@ -25,13 +25,24 @@ Our repository on Docker Hub: https://hub.docker.com/r/photoprism/photoprism-arm ## Docker Compose Command Reference ## -Update: sudo docker-compose pull photoprism -Stop: sudo docker-compose stop photoprism -Start: sudo docker-compose up -d photoprism -Logs: sudo docker-compose logs --tail=20 -Terminal: sudo docker-compose exec photoprism bash -Help: sudo docker-compose exec photoprism photoprism help -Config: sudo docker-compose exec photoprism photoprism config +Please prefix with `sudo` if your current user doesn't have permission +to run Docker commands: + +| Action | Command | +|----------|-----------------------------------------------------------| +| Update | `docker-compose pull photoprism` | +| Stop | `docker-compose stop photoprism` | +| Start | `docker-compose up -d photoprism` | +| Logs | `docker-compose logs --tail=25 -f` | +| Terminal | `docker-compose exec photoprism bash` | +| Help | `docker-compose exec photoprism photoprism help` | +| Config | `docker-compose exec photoprism photoprism config` | +| Reset | `docker-compose exec photoprism photoprism reset` | +| Backup | `docker-compose exec photoprism photoprism backup -a -i` | +| Restore | `docker-compose exec photoprism photoprism restore -a -i` | +| Import | `docker-compose exec photoprism photoprism import` | +| Index | `docker-compose exec photoprism photoprism index` | +| Reindex | `docker-compose exec photoprism photoprism index -a` | ## System Requirements ## diff --git a/docker/examples/arm64/docker-compose.yml b/docker/examples/arm64/docker-compose.yml index a02e1c457..187b2329e 100644 --- a/docker/examples/arm64/docker-compose.yml +++ b/docker/examples/arm64/docker-compose.yml @@ -8,15 +8,25 @@ 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. # +# ------------------------------------------------------------------- # DOCKER COMPOSE COMMAND REFERENCE -# --------------------------------------------------------------- -# Update: sudo docker-compose pull photoprism -# Stop: sudo docker-compose stop photoprism -# Start: sudo docker-compose up -d photoprism -# Logs: sudo docker-compose logs --tail=20 -# Terminal: sudo docker-compose exec photoprism bash -# Help: sudo docker-compose exec photoprism photoprism help -# Config: sudo docker-compose exec photoprism photoprism config +# ------------------------------------------------------------------- +# Update | docker-compose pull photoprism +# Stop | docker-compose stop photoprism +# Start | docker-compose up -d photoprism +# Logs | docker-compose logs --tail=25 -f +# Terminal | docker-compose exec photoprism bash +# Help | docker-compose exec photoprism photoprism help +# Config | docker-compose exec photoprism photoprism config +# Reset | docker-compose exec photoprism photoprism reset +# Backup | docker-compose exec photoprism photoprism backup -a -i +# Restore | docker-compose exec photoprism photoprism restore -a -i +# Index | docker-compose exec photoprism photoprism index +# Reindex | docker-compose exec photoprism photoprism index -a +# Import | docker-compose exec photoprism photoprism import +# ------------------------------------------------------------------- +# Note: Prefix with "sudo" if the current user doesn't have +# permission to run Docker commands. services: photoprism: diff --git a/docker/examples/docker-compose.yml b/docker/examples/docker-compose.yml index 99a1565d3..81af9c4c7 100644 --- a/docker/examples/docker-compose.yml +++ b/docker/examples/docker-compose.yml @@ -8,15 +8,25 @@ 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. # +# ------------------------------------------------------------------ # 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 +# ------------------------------------------------------------------ +# Update | docker-compose pull photoprism +# Stop | docker-compose stop photoprism +# Start | docker-compose up -d photoprism +# Logs | docker-compose logs --tail=25 -f +# Terminal | docker-compose exec photoprism bash +# Help | docker-compose exec photoprism photoprism help +# Config | docker-compose exec photoprism photoprism config +# Reset | docker-compose exec photoprism photoprism reset +# Backup | docker-compose exec photoprism photoprism backup -a -i +# Restore | docker-compose exec photoprism photoprism restore -a -i +# Index | docker-compose exec photoprism photoprism index +# Reindex | docker-compose exec photoprism photoprism index -a +# Import | docker-compose exec photoprism photoprism import +# ------------------------------------------------------------------- +# Note: Prefix with "sudo" if the current user doesn't have +# permission to run Docker commands. services: photoprism: diff --git a/docker/examples/macos/docker-compose.yml b/docker/examples/macos/docker-compose.yml index ca6288ef8..297971008 100644 --- a/docker/examples/macos/docker-compose.yml +++ b/docker/examples/macos/docker-compose.yml @@ -8,15 +8,23 @@ 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. # +# ------------------------------------------------------------------ # 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 +# ------------------------------------------------------------------ +# Update | docker-compose pull photoprism +# Stop | docker-compose stop photoprism +# Start | docker-compose up -d photoprism +# Logs | docker-compose logs --tail=25 -f +# Terminal | docker-compose exec photoprism bash +# Help | docker-compose exec photoprism photoprism help +# Config | docker-compose exec photoprism photoprism config +# Reset | docker-compose exec photoprism photoprism reset +# Backup | docker-compose exec photoprism photoprism backup -a -i +# Restore | docker-compose exec photoprism photoprism restore -a -i +# Index | docker-compose exec photoprism photoprism index +# Reindex | docker-compose exec photoprism photoprism index -a +# Import | docker-compose exec photoprism photoprism import +# ------------------------------------------------------------------- services: photoprism: diff --git a/docker/examples/sqlite/docker-compose.yml b/docker/examples/sqlite/docker-compose.yml index 0d23c2d91..4136ae90a 100644 --- a/docker/examples/sqlite/docker-compose.yml +++ b/docker/examples/sqlite/docker-compose.yml @@ -8,15 +8,25 @@ 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. # +# ------------------------------------------------------------------ # 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 +# ------------------------------------------------------------------ +# Update | docker-compose pull photoprism +# Stop | docker-compose stop photoprism +# Start | docker-compose up -d photoprism +# Logs | docker-compose logs --tail=25 -f +# Terminal | docker-compose exec photoprism bash +# Help | docker-compose exec photoprism photoprism help +# Config | docker-compose exec photoprism photoprism config +# Reset | docker-compose exec photoprism photoprism reset +# Backup | docker-compose exec photoprism photoprism backup -a -i +# Restore | docker-compose exec photoprism photoprism restore -a -i +# Index | docker-compose exec photoprism photoprism index +# Reindex | docker-compose exec photoprism photoprism index -a +# Import | docker-compose exec photoprism photoprism import +# ------------------------------------------------------------------- +# Note: Prefix with "sudo" if the current user doesn't have +# permission to run Docker commands. services: photoprism: diff --git a/docker/examples/windows/docker-compose.yml b/docker/examples/windows/docker-compose.yml index 71355e19b..9a5656b74 100644 --- a/docker/examples/windows/docker-compose.yml +++ b/docker/examples/windows/docker-compose.yml @@ -11,15 +11,23 @@ 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. # +# ------------------------------------------------------------------ # 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 +# ------------------------------------------------------------------ +# Update | docker-compose pull photoprism +# Stop | docker-compose stop photoprism +# Start | docker-compose up -d photoprism +# Logs | docker-compose logs --tail=25 -f +# Terminal | docker-compose exec photoprism bash +# Help | docker-compose exec photoprism photoprism help +# Config | docker-compose exec photoprism photoprism config +# Reset | docker-compose exec photoprism photoprism reset +# Backup | docker-compose exec photoprism photoprism backup -a -i +# Restore | docker-compose exec photoprism photoprism restore -a -i +# Index | docker-compose exec photoprism photoprism index +# Reindex | docker-compose exec photoprism photoprism index -a +# Import | docker-compose exec photoprism photoprism import +# ------------------------------------------------------------------- services: photoprism: