Documentation
Run Keyring yourself or on Unkey, connect your auth provider, and give your agents access.
Get started
Self-hostKeyring is one container plus a Postgres database. This guide runs it with Docker Compose on your own machine, then on any host that runs containers. To deploy on Unkey Deploy, follow Deploy…Deploy on UnkeyThis guide puts Keyring on Unkey Deploy (Unkey's docs also call it Unkey Compute), connected to a Postgres database you host elsewhere. At the end, Keyring runs at an unkey.app URL and your auth…ConfigurationKeyring reads its configuration from environment variables when it starts. cmd/keyring/main.go reads them all in loadConfig, and this page lists every one. A change takes effect on the next start.Sign-inPeople sign in to the Keyring UI with a passkey or with an account at a configured provider. A password exists only when you turn it on, and it is never enough alone. API keys for agents and…AgentsAgents reach Keyring in two ways. The MCP server at /mcp gives an agent tools to search, read, and update contacts. The REST API under /v1 does the same over plain HTTP. Both call the same code as…
Auth providers
ClerkClerk sends webhooks through Svix, signed with the Standard Webhooks scheme. Setup is one endpoint and one pasted secret.WorkOS AuthKitWorkOS sends signed webhooks, so setup is one endpoint and one pasted secret.Better AuthThis page connects Better Auth's sign-up webhooks, which record your product's users as contacts. To sign in to Keyring itself with your Better Auth accounts, see Sign in through Better Auth.Supabase AuthSupabase Auth has no sign-up webhook, so Keyring gives you a SQL snippet that adds triggers on auth.users. The triggers use pgnet to POST each new, changed or deleted user to Keyring with…Auth0Keyring takes Auth0 users from an Event Streams webhook. Auth0 authenticates each delivery with a bearer token that Keyring generates for you. If your tenant has no Event Streams, a Post-Login…StytchStytch sends webhooks through Svix, signed with the Standard Webhooks scheme. Setup is one endpoint and one pasted secret. Both Consumer and B2B projects work.