From e90de9a1d72429537c8d5eb520aebee23b459cf3 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 28 Dec 2020 14:43:29 +0100 Subject: [PATCH] Config: Improve Raspberry Pi docs #748 Signed-off-by: Michael Mayer --- docker/examples/arm64/README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/docker/examples/arm64/README.md b/docker/examples/arm64/README.md index 1e1990dc1..cf5597c69 100644 --- a/docker/examples/arm64/README.md +++ b/docker/examples/arm64/README.md @@ -4,14 +4,24 @@ PhotoPrism for Raspberry Pi (64bit) Big thank you to [Guy Sheffer](https://github.com/guysoft) for [building](https://github.com/photoprism/photoprism/issues/109) this! -Download our docker-compose.yml file (right click and Save Link As... or use wget) to a folder of your choice, -and change the configuration as needed: +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: ``` wget https://dl.photoprism.org/docker/arm64/docker-compose.yml +sudo docker-compose up ``` -Our image repository on Docker Hub: https://hub.docker.com/r/photoprism/photoprism-arm64 +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/) +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 `insecure` as password if you're running it on a public server. ## Docker Compose Command Reference ## @@ -31,12 +41,15 @@ It's a 64bit Ubuntu Server with Docker pre-installed. Indexing large photo and video collections significantly benefits from fast, local SSD storage and enough memory for caching. -If you're running out of memory - or other system resources - while indexing, please reduce the number of workers to a -value less than the number of logical CPU cores. Also make sure your server has swap configured, so that indexing -doesn't cause restarts when there are memory usage spikes. As a measure of last resort, you may additionally disable -image classification using TensorFlow. +!!! tip "Reducing Server Load" + If you're running out of memory - or other system resources - while indexing, please limit the + [number of workers](https://docs.photoprism.org/getting-started/config-options/) by setting + `PHOTOPRISM_WORKERS` to a value less than the number of logical CPU cores in `docker-compose.yml`. + Also make sure your server has [swap](https://opensource.com/article/18/9/swap-space-linux-systems) + configured so that indexing doesn't cause restarts when there are memory usage spikes. + As a measure of last resort, you may additionally disable image classification using TensorFlow. -To prevent permission issues, your Docker Compose config must include the following security options: +To avoid permission issues, docker-compose.yml should include the following security options: ``` photoprism: