Skip to content
v2.18.0GitHub

PhotoPrism

Sign in to the PhotoPrism photo library with Pocket ID.

  1. In Pocket ID, open Administration → OIDC Clients and click Add OIDC Client.
  2. Enter a name such as PhotoPrism and add the callback URL https://photoprism.example.com/api/v1/oidc/redirect.
  3. Click Create and copy the Client ID and the Client secret. The client secret is only shown once.
  4. On the client’s General tab, set Client Launch URL to https://photoprism.example.com, then click Save.
  5. On the client’s Access tab, select the groups that may sign in under Allowed User Groups, or choose All Users.

Check out PhotoPrism’s OIDC Docs for more details. If you have PhotoPrism Pro, see the additional options in the Pro OIDC Docs.

Configure the following environment variables:

# Required
PHOTOPRISM_OIDC_URI: https://id.example.com
PHOTOPRISM_OIDC_CLIENT: <client-id>
PHOTOPRISM_OIDC_SECRET: <client-secret>
# Enable Auto User Registration
PHOTOPRISM_OIDC_REGISTER: true/false

Optional configuration:

# Custom Identity Provider Name
PHOTOPRISM_OIDC_PROVIDER: Pocket ID
PHOTOPRISM_OIDC_REDIRECT: true/false
PHOTOPRISM_OIDC_ICON: <path>