Running PhotoPrism with Docker¶
These instructions are for users who don't like Docker Compose for any reason and prefer pure Docker instead. If you are not sure, try using Docker Compose first.
Step 1: Start the server¶
Open a terminal and run this command after replacing
the folder containing your personal photo and video collection:
docker run -d \ --name photoprism \ --security-opt seccomp=unconfined \ --security-opt apparmor=unconfined \ -p 2342:2342 \ -e PHOTOPRISM_UPLOAD_NSFW="true" \ -e PHOTOPRISM_ADMIN_PASSWORD="please-change" \ -v /photoprism/storage \ -v ~/Pictures:/photoprism/originals \ photoprism/photoprism
PHOTOPRISM_ADMIN_PASSWORD so that PhotoPrism starts with a secure initial password.
photoprism as password if you're running it on a public server.
Now open http://localhost:2342/ in a Web browser to see the user interface
and sign in using the password set in
You may change it in Settings, or using the
photoprism passwd command in a terminal.
This is a simplified configuration compared to our Docker Compose example:
/photoprism/importfolder is not mounted so that you can't easily access it from your host machine. Uploading files or mounting it via WebDAV is still possible.
- Settings, index, sidecar files, and generated thumbnails will be stored
/photoprism/storage. You may also mount this path to a local folder instead of an anonymous volume.
The default port 2342 and other configuration values can be changed as needed, see Config Options.
Multiple folders can be indexed by mounting them as sub-folders of
Your original media files won't be deleted, modified, or moved.
If you still want to enable the read-only mode, you can do so by adding
It will disable all features that require write permissions, like importing files via Web upload.
You may additionally want to mount the originals folder with
:ro flag so that Docker
blocks write operations.
Step 2: Index your library¶
Go to Library in our Web UI to start indexing or importing. Alternatively, you can run this command in a terminal to index all files in your originals folder:
docker exec -ti photoprism photoprism index
While indexing, a JPEG sidecar file may automatically be created for RAW, HEIF, TIFF, PNG, BMP, and GIF files. It is required for classification and resampling. By default, it will be created in the storage folder, so that your originals can be mounted read-only. You may configure PhotoPrism to store it in the same folder, next to the original, instead.
Pictures will become visible one after another. You can watch the indexer working in the terminal, or the Logs tab in Library.
If you're running out of memory while indexing, it often helps to limit the
number of workers by setting
an explicit value for
Make sure the server has swap
configured so that indexing doesn't stop when there are memory usage spikes.
As a measure of last resort, you may additionally disable image classification using TensorFlow.
photoprism index --all will re-index all originals, including already indexed and unchanged files. This may be
necessary after upgrading, especially to new major versions.
Step 3: When you're done...¶
You can stop the server and start it again using the following commands:
docker stop photoprism docker start photoprism
To remove the container completely:
docker rm -f photoprism