Files
paskia/README.md
T
2026-02-05 21:38:57 +00:00

3.3 KiB

Paskia

Login dialog screenshot

An easy to install passkey-based authentication service that protects any web application with strong passwordless login.

What is Paskia?

  • Easy to use fully featured auth&auth system (login and permissions)
  • Organization and role-based access control (optional)
    • Org admins control their users and roles
    • Master admin can create multiple independent orgs
    • Master admin makes permissions available for orgs to assign
  • User Profile and Administration by API and web interface. under /auth/ or auth.example.com
  • Reset tokens and additional device linking via QR code or codewords.
  • Pure Python, FastAPI, packaged with prebuilt Vue frontend

Two interfaces:

  • API fetch: auth checks and login without leaving your app
  • Forward-auth proxy: protect any unprotected site or service (Caddy, Nginx)

The API mode is useful for applications that can be customized to run with Paskia. Forward auth can also protect your javascript and other assets. Each provides fine-grained permission control and reauthentication requests where needed, and both can be mixed where needed.

Single Sign-On (SSO): Users register once and authenticate across all applications under your domain name (configured rp-id).

Forbidden dialog, dark mode Automatic light/dark mode switching with overrides by user profile and protected app's theme.

Quick Start

Install UV and run:

uvx paskia --rp-id example.com

On the first run it downloads the software and prints a registration link for the Admin. The server starts on localhost:4401, serving authentication for *.example.com. For local testing, leave out --rp-id.

For production you need a web server such as Caddy to serve HTTPS on your actual domain names and proxy requests to Paskia and your backend apps (see documentation below).

For a permanent install of paskia CLI command, not needing uvx:

uv tool install paskia

Configuration

All configuration is passed by CLI arguments, of which there are just a few.

paskia [options]
paskia reset [user]     # Generate passkey reset link
Option Description Default
-l, --listen endpoint Listen address: host:port, :port (all interfaces), or /path.sock localhost:4401
--rp-id domain Main/top domain for passkeys localhost
--rp-name "text" Name shown during passkey registration Same as rp-id
--origin url Restrict allowed origins for WebSocket auth (repeatable) All under rp-id
--auth-host url Dedicated authentication site, e.g. auth.example.com Use /auth/ path on each site

Further Documentation