Awesome

<div align="center"><img src="https://github.com/user-attachments/assets/4ceb2708-9f29-4694-b797-be833efce17d" width="100"/> </br>Pocket ID</div>

Pocket ID is a simple OIDC provider that allows users to authenticate with their passkeys to your services.

→ Try out the Demo

The goal of Pocket ID is to be a simple and easy-to-use. There are other self-hosted OIDC providers like Keycloak or ORY Hydra but they are often too complex for simple use cases.

Additionally, what makes Pocket ID special is that it only supports passkey authentication, which means you don’t need a password. Some people might not like this idea at first, but I believe passkeys are the future, and once you try them, you’ll love them. For example, you can now use a physical Yubikey to sign in to all your self-hosted services easily and securely.

Setup

[!WARNING]
Pocket ID is in its early stages and may contain bugs. There might be OIDC features that are not yet implemented. If you encounter any issues, please open an issue.

Before you start

Pocket ID requires a secure context, meaning it must be served over HTTPS. This is necessary because Pocket ID uses the WebAuthn API.

Installation with Docker (recommended)

Download the docker-compose.yml and .env file:

 curl -O https://raw.githubusercontent.com/stonith404/pocket-id/main/docker-compose.yml

 curl -o .env https://raw.githubusercontent.com/stonith404/pocket-id/main/.env.example

Edit the .env file so that it fits your needs. See the environment variables section for more information.
Run docker compose up -d

You can now sign in with the admin account on http://localhost/login/setup.

Unraid

Pocket ID is available as a template on the Community Apps store.

Stand-alone Installation

Required tools:

Node.js >= 20
Go >= 1.23
Git
PM2
Caddy (optional)

Copy the .env.example file in the frontend and backend folder to .env and change it so that it fits your needs.
```
cp frontend/.env.example frontend/.env
cp backend/.env.example backend/.env
```

Run the following commands:

git clone https://github.com/stonith404/pocket-id
cd pocket-id

# Checkout the latest version
git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`)

# Start the backend
cd backend/cmd
go build -o ../pocket-id-backend
cd ..
pm2 start pocket-id-backend --name pocket-id-backend

# Start the frontend
cd ../frontend
npm install
npm run build
pm2 start --name pocket-id-frontend --node-args="--env-file .env" build/index.js

# Optional: Start Caddy (You can use any other reverse proxy)
cd ..
pm2 start --name pocket-id-caddy caddy -- run --config reverse-proxy/Caddyfile

You can now sign in with the admin account on http://localhost/login/setup.

Nginx Reverse Proxy

To use Nginx as a reverse proxy for Pocket ID, update the configuration to increase the header buffer size. This adjustment is necessary because SvelteKit generates larger headers, which may exceed the default buffer limits.

proxy_busy_buffers_size   512k;
proxy_buffers   4 512k;
proxy_buffer_size   256k;

Proxy Services with Pocket ID

As the goal of Pocket ID is to stay simple, it doesn't have a built-in proxy provider. However, you can use OAuth2 Proxy to add authentication to your services that don't support OIDC.

See the guide for more information.

Update

Docker

docker compose pull
docker compose up -d

Stand-alone

Stop the running services:

pm2 delete pocket-id-backend pocket-id-frontend pocket-id-caddy

Run the following commands:

cd pocket-id

# Checkout the latest version
git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`)

# Start the backend
cd backend/cmd
go build -o ../pocket-id-backend
cd ..
pm2 start pocket-id-backend --name pocket-id-backend

# Start the frontend
cd ../frontend
npm install
npm run build
pm2 start build/index.js --name pocket-id-frontend

# Optional: Start Caddy (You can use any other reverse proxy)
cd ..
pm2 start caddy --name pocket-id-caddy -- run --config reverse-proxy/Caddyfile

Environment variables

Variable	Default Value	Recommended to change	Description
`PUBLIC_APP_URL`	`http://localhost`	yes	The URL where you will access the app.
`TRUST_PROXY`	`false`	yes	Whether the app is behind a reverse proxy.
`MAXMIND_LICENSE_KEY`	`-`	yes	License Key for the GeoLite2 Database. The license key is required to retrieve the geographical location of IP addresses in the audit log. If the key is not provided, IP locations will be marked as "unknown." You can obtain a license key for free here.
`PUID` and `PGID`	`1000`	yes	The user and group ID of the user who should run Pocket ID inside the Docker container and owns the files that are mounted with the volume. You can get the `PUID` and `GUID` of your user on your host machine by using the command `id`. For more information see this article.
`DB_PROVIDER`	`sqlite`	no	The database provider you want to use. Currently `sqlite` and `postgres` are supported.
`SQLITE_DB_PATH`	`data/pocket-id.db`	no	The path to the SQLite database. This gets ignored if you didn't set `DB_PROVIDER` to `sqlite`.
`POSTGRES_CONNECTION_STRING`	`-`	no	The connection string to your Postgres database. This gets ignored if you didn't set `DB_PROVIDER` to `postgres`. A connection string can look like this: `postgresql://user:password@host:5432/pocket-id`.
`UPLOAD_PATH`	`data/uploads`	no	The path where the uploaded files are stored.
`INTERNAL_BACKEND_URL`	`http://localhost:8080`	no	The URL where the backend is accessible.
`GEOLITE_DB_PATH`	`data/GeoLite2-City.mmdb`	no	The path where the GeoLite2 database should be stored.
`CADDY_PORT`	`80`	no	The port on which Caddy should listen. Caddy is only active inside the Docker container. If you want to change the exposed port of the container then you sould change this variable.
`PORT`	`3000`	no	The port on which the frontend should listen.
`BACKEND_PORT`	`8080`	no	The port on which the backend should listen.

Contribute

You're very welcome to contribute to Pocket ID! Please follow the contribution guide to get started.