PhotoPrism

https://docs.photoprism.app
Admin
PhotoPrism is an AI-powered, privacy-first application for browsing, organizing, and sharing photos...
Tokens:470,358
Snippets:2,939
Trust Score:10
Update:5 hours ago
Show doc for...
Tokens:
Raw
### Download and run Windows install.bat

Source: https://docs.photoprism.app/getting-started/docker-compose/

Download the Windows install.bat script and run it to automatically download all required config files and start the PhotoPrism server. Run these commands in the directory where you want to install PhotoPrism, and ensure Docker Desktop is installed and started.

```bash
curl.exe -o install.bat https://dl.photoprism.app/docker/windows/install.bat
install.bat
```

--------------------------------

### Install and start Tailscale on Linux server

Source: https://docs.photoprism.app/getting-started/vpn/tailscale/

Run these commands on the PhotoPrism host to install Tailscale, enable the tailscaled service, and bring up the VPN with DNS and an auth key. Generate one-time auth keys in the Admin Console or authenticate interactively with `sudo tailscale up`.

```bash
curl -fsSL https://tailscale.com/install.sh | sh
sudo systemctl enable --now tailscaled
sudo tailscale up --accept-dns=true --authkey tskey-auth-XXXXXXXXXXXXXXXX
```

--------------------------------

### Start PhotoPrism with Podman

Source: https://docs.photoprism.app/getting-started/docker/

Run this command to start PhotoPrism with Podman, a drop-in replacement for Docker on Red Hat-compatible Linux distributions. Replace ~/Pictures with your pictures folder. Note the --privileged flag and that you should replace 'docker' with 'podman' in other examples.

```bash
podman run -d \
  --name photoprism \
  --privileged \
  --security-opt seccomp=unconfined \
  --security-opt apparmor=unconfined \
  -p 2342:2342 \
  -e PHOTOPRISM_UPLOAD_NSFW="true" \
  -e PHOTOPRISM_ADMIN_PASSWORD="insecure" \
  -v ~/PhotoPrism/storage:/photoprism/storage \
  -v ~/Pictures:/photoprism/originals \
  photoprism/photoprism:latest
```

--------------------------------

### Build and install PhotoPrism from source

Source: https://docs.photoprism.app/getting-started/faq/

Clone the PhotoPrism repository and run the make command to build and install it. This method requires manual installation of build and system dependencies, as shown in the Dockerfiles. Support for private users is limited, and Docker Compose or installation packages are recommended.

```bash
git clone https://github.com/photoprism/photoprism.git
cd photoprism
make all install DESTDIR=/opt/photoprism
```

--------------------------------

### Enable and start NGINX service

Source: https://docs.photoprism.app/getting-started/advanced/nginx-proxy-setup/

Enables and starts the NGINX service using systemd, in case it was not started automatically during installation.

```bash
sudo systemctl enable --now nginx
```

--------------------------------

### Install libheif-examples and exiftool via apt

Source: https://docs.photoprism.app/developer-guide/media/heif/

Installs the required packages for HEIF conversion and metadata viewing inside the Debian container.

```bash
apt update
apt install -y libheif-examples exiftool
```

--------------------------------

### .ppignore file example

Source: https://docs.photoprism.app/user-guide/library/originals/

Example of a .ppignore file that ignores a directory, folders starting with '#', all files, GIF files, and videos starting with 'MVI'. Place it in the originals or import folder to limit its scope to that directory and subdirectories.

```plaintext
# ignore a directory by its name
foo
# ignore all folders starting with a #
[#]*
# ignore all files
*.*
# ignore all files with gif extension
*.gif
# ignore videos which name start with MVI
MVI_*.MOV
# or
MVI_*.*
```

--------------------------------

### Install QEMU user-static

Source: https://docs.photoprism.app/developer-guide/setup/

Run this command to install qemu-user-static from Docker Hub, which is required for emulating multiple CPU architectures during Docker builds.

```bash
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
```

--------------------------------

### Start MCP server locally with MCP Inspector

Source: https://docs.photoprism.app/developer-guide/api/mcp/

Starts the MCP server via stdio with the MCP Inspector for local testing, for example in the development environment.

```bash
npx @modelcontextprotocol/inspector ./photoprism mcp serve
```

--------------------------------

### Install dependencies

Source: https://docs.photoprism.app/developer-guide/setup/

Run this command to install all dependencies, such as NPM packages and AI models, before building.

```bash
make dep
```

--------------------------------

### Start Ollama with Docker Compose using the ollama profile

Source: https://docs.photoprism.app/user-guide/ai/using-ollama/

Use this command to start the preconfigured Ollama service from the PhotoPrism compose.yaml examples. Remove 'profiles: ["ollama"]' from the service to start it by default without the --profile flag.

```bash
docker compose --profile ollama up -d
```

--------------------------------

### Wildcard prefix search

Source: https://docs.photoprism.app/user-guide/search/filters/

Use * as wildcard. The example shows photos whose name starts with IMG_23.

```text
name:"IMG_23*"
```

--------------------------------

### Build and start PhotoPrism

Source: https://docs.photoprism.app/developer-guide/setup/

Build the frontend assets (JS), compile the backend binary (Go), and then run a custom PhotoPrism version in your local environment.

```bash
make build-js
```

```bash
make build-go
```

```bash
./photoprism start
```

--------------------------------

### Set up local PhotoPrism development environment

Source: https://docs.photoprism.app/developer-guide/security/

Clones the PhotoPrism repository, builds the Docker image, and starts the services with Docker Compose. Use this to create a local testing environment for security checks.

```bash
git clone https://github.com/photoprism/photoprism.git
cd photoprism
make docker-build
docker compose up -d
```

--------------------------------

### GET request to places.photoprism.app

Source: https://docs.photoprism.app/developer-guide/metadata/geocoding/

Example request to the PhotoPrism geocoding API endpoint. Returns JSON location data for the given ID.

```http
GET https://places.photoprism.app/v1/location/149ce78563
```

--------------------------------

### Show detailed command description with --help flag

Source: https://docs.photoprism.app/getting-started/docker-compose/

Use `docker compose exec photoprism photoprism backup --help` to see a detailed description of the backup command.

```bash
docker compose exec photoprism photoprism backup --help
```

--------------------------------

### Download compose.yaml for ARMv7 using wget

Source: https://docs.photoprism.app/getting-started/docker-compose/

Use wget to download the PhotoPrism compose.yaml example for older ARMv7-based devices. Commands may need to be prefixed with sudo when not running as root. Ensure the device meets system requirements and has at least 4 GB of swap configured.

```bash
wget https://dl.photoprism.app/docker/armv7/compose.yaml
```

--------------------------------

### Run ExifTool in Docker container

Source: https://docs.photoprism.app/developer-guide/metadata/exif/

Starts a Debian container with ExifTool and libheif-examples installed, useful for reproducing PhotoPrism's Stage 2 output.

```bash
docker run --rm -v ${PWD}:/test -w /test -ti debian:bookworm bash
apt update && apt install -y exiftool libheif-examples
```
Tokens:
Raw