From 287b34de77d969fea4b4b48a70f604bc11838afa Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Sat, 2 Jan 2021 05:44:49 +0100 Subject: [PATCH] Config: Improve docker-compose.yml examples Signed-off-by: Michael Mayer --- docker/examples/arm64/README.md | 28 ++++++++++------------ docker/examples/arm64/docker-compose.yml | 6 ++--- docker/examples/docker-compose.yml | 6 ++--- docker/examples/macos/docker-compose.yml | 6 ++--- docker/examples/sqlite/docker-compose.yml | 6 ++--- docker/examples/windows/docker-compose.yml | 6 ++--- 6 files changed, 28 insertions(+), 30 deletions(-) diff --git a/docker/examples/arm64/README.md b/docker/examples/arm64/README.md index cdf04e750..b293f3e84 100644 --- a/docker/examples/arm64/README.md +++ b/docker/examples/arm64/README.md @@ -6,33 +6,31 @@ Big thank you to [Guy Sheffer](https://github.com/guysoft) for Download our [docker-compose.yml](https://dl.photoprism.org/docker/arm64/docker-compose.yml) file (right click and *Save Link As...* or use `wget`) to a folder of your choice, -change the configuration as needed, and run `sudo docker-compose up` to start PhotoPrism: +change the configuration as needed, and run `docker-compose up` to start PhotoPrism: ``` wget https://dl.photoprism.org/docker/arm64/docker-compose.yml -sudo docker-compose up +sudo docker-compose up -d ``` -The default port 2342 and other configuration values may be changed as needed, -see [Setup Using Docker Compose](https://docs.photoprism.org/getting-started/docker-compose/) +Please always change PHOTOPRISM_ADMIN_PASSWORD so that PhotoPrism starts with a secure initial password. +Never use "photoprism", or other easy-to-guess passwords, on a public server. + +See [Setup Using Docker Compose](https://docs.photoprism.org/getting-started/docker-compose/) and [Config Options](https://docs.photoprism.org/getting-started/config-options/) for details. -Our repository on Docker Hub: https://hub.docker.com/r/photoprism/photoprism-arm64 - -!!! attention - Please change PHOTOPRISM_ADMIN_PASSWORD so that PhotoPrism starts with a secure initial password. - Never use "photoprism", or other easy-to-guess passwords, on a public server. - -## Docker Compose Command Reference ## - All commands may have to be prefixed with `sudo` when not running as root. Note that this will change the home directory `~` to `/root` in your configuration. +Our repository on Docker Hub: https://hub.docker.com/r/photoprism/photoprism-arm64 + +## Docker Compose Command Reference ## + | Action | Command | |------------------|-----------------------------------------------------------| -| Start | `docker-compose up -d photoprism` | -| Stop | `docker-compose stop photoprism` | -| Update | `docker-compose pull photoprism` | +| Start | `docker-compose up -d` | +| Stop | `docker-compose stop` | +| Update | `docker-compose pull` | | View Logs | `docker-compose logs --tail=25 -f` | | Open Terminal | `docker-compose exec photoprism bash` | | Show Help | `docker-compose exec photoprism photoprism help` | diff --git a/docker/examples/arm64/docker-compose.yml b/docker/examples/arm64/docker-compose.yml index 34083a2a3..f4d6a7203 100644 --- a/docker/examples/arm64/docker-compose.yml +++ b/docker/examples/arm64/docker-compose.yml @@ -11,9 +11,9 @@ version: '3.5' # ------------------------------------------------------------------- # DOCKER COMPOSE COMMAND REFERENCE # ------------------------------------------------------------------- -# Start | docker-compose up -d photoprism -# Stop | docker-compose stop photoprism -# Update | docker-compose pull photoprism +# Start | docker-compose up -d +# Stop | docker-compose stop +# Update | docker-compose pull # Logs | docker-compose logs --tail=25 -f # Terminal | docker-compose exec photoprism bash # Help | docker-compose exec photoprism photoprism help diff --git a/docker/examples/docker-compose.yml b/docker/examples/docker-compose.yml index f37b44d42..c77cbf6d8 100644 --- a/docker/examples/docker-compose.yml +++ b/docker/examples/docker-compose.yml @@ -11,9 +11,9 @@ version: '3.5' # ------------------------------------------------------------------ # DOCKER COMPOSE COMMAND REFERENCE # ------------------------------------------------------------------ -# Start | docker-compose up -d photoprism -# Stop | docker-compose stop photoprism -# Update | docker-compose pull photoprism +# Start | docker-compose up -d +# Stop | docker-compose stop +# Update | docker-compose pull # Logs | docker-compose logs --tail=25 -f # Terminal | docker-compose exec photoprism bash # Help | docker-compose exec photoprism photoprism help diff --git a/docker/examples/macos/docker-compose.yml b/docker/examples/macos/docker-compose.yml index d3e162e90..481d9f3fa 100644 --- a/docker/examples/macos/docker-compose.yml +++ b/docker/examples/macos/docker-compose.yml @@ -11,9 +11,9 @@ version: '3.5' # ------------------------------------------------------------------ # DOCKER COMPOSE COMMAND REFERENCE # ------------------------------------------------------------------ -# Start | docker-compose up -d photoprism -# Stop | docker-compose stop photoprism -# Update | docker-compose pull photoprism +# Start | docker-compose up -d +# Stop | docker-compose stop +# Update | docker-compose pull # Logs | docker-compose logs --tail=25 -f # Terminal | docker-compose exec photoprism bash # Help | docker-compose exec photoprism photoprism help diff --git a/docker/examples/sqlite/docker-compose.yml b/docker/examples/sqlite/docker-compose.yml index 8cea16ea9..bb6c23c83 100644 --- a/docker/examples/sqlite/docker-compose.yml +++ b/docker/examples/sqlite/docker-compose.yml @@ -11,9 +11,9 @@ version: '3.5' # ------------------------------------------------------------------ # DOCKER COMPOSE COMMAND REFERENCE # ------------------------------------------------------------------ -# Start | docker-compose up -d photoprism -# Stop | docker-compose stop photoprism -# Update | docker-compose pull photoprism +# Start | docker-compose up -d +# Stop | docker-compose stop +# Update | docker-compose pull # Logs | docker-compose logs --tail=25 -f # Terminal | docker-compose exec photoprism bash # Help | docker-compose exec photoprism photoprism help diff --git a/docker/examples/windows/docker-compose.yml b/docker/examples/windows/docker-compose.yml index 6ec640465..22df7eac7 100644 --- a/docker/examples/windows/docker-compose.yml +++ b/docker/examples/windows/docker-compose.yml @@ -14,9 +14,9 @@ version: '3.5' # ------------------------------------------------------------------ # DOCKER COMPOSE COMMAND REFERENCE # ------------------------------------------------------------------ -# Start | docker-compose up -d photoprism -# Stop | docker-compose stop photoprism -# Update | docker-compose pull photoprism +# Start | docker-compose up -d +# Stop | docker-compose stop +# Update | docker-compose pull # Logs | docker-compose logs --tail=25 -f # Terminal | docker-compose exec photoprism bash # Help | docker-compose exec photoprism photoprism help