Javier Feliz 821e49288d
Some checks failed
linter / quality (push) Successful in 7m10s
tests / ci (push) Failing after 10m19s
Finally just moved the docs here
2025-08-04 19:12:42 -04:00

25 lines
11 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>AuthentiKate</title>
<meta name="description" content="The OIDC/SSO solution for homelabbers">
<meta name="generator" content="VitePress v1.6.3">
<link rel="preload stylesheet" href="/assets/style.DC_1oGt7.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
<script type="module" src="/assets/app.Gyz6141_.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.DH4SPjp6.js">
<link rel="modulepreload" href="/assets/chunks/framework.ko2zIC2c.js">
<link rel="modulepreload" href="/assets/index.md.CrUm1VXh.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-d8b57b2d><!--[--><!--]--><!--[--><span tabindex="-1" data-v-fcbfc0e0></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-fcbfc0e0>Skip to content</a><!--]--><!----><header class="VPNav" data-v-d8b57b2d data-v-7ad780c2><div class="VPNavBar" data-v-7ad780c2 data-v-9fd4d1dd><div class="wrapper" data-v-9fd4d1dd><div class="container" data-v-9fd4d1dd><div class="title" data-v-9fd4d1dd><div class="VPNavBarTitle" data-v-9fd4d1dd data-v-9f43907a><a class="title" href="/" data-v-9f43907a><!--[--><!--]--><!----><span data-v-9f43907a>AuthentiKate</span><!--[--><!--]--></a></div></div><div class="content" data-v-9fd4d1dd><div class="content-body" data-v-9fd4d1dd><!--[--><!--]--><div class="VPNavBarSearch search" data-v-9fd4d1dd><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-9fd4d1dd data-v-afb2845e><span id="main-nav-aria-label" class="visually-hidden" data-v-afb2845e> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/quick-start/" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>Quick Start</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-9fd4d1dd data-v-3f90c1a5><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-3f90c1a5 data-v-be9742d9 data-v-b4ccac88><span class="check" data-v-b4ccac88><span class="icon" data-v-b4ccac88><!--[--><span class="vpi-sun sun" data-v-be9742d9></span><span class="vpi-moon moon" data-v-be9742d9></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-9fd4d1dd data-v-ef6192dc data-v-e71e869c><!--[--><a class="VPSocialLink no-icon" href="https://gitgud.foo/thegrind/authentikate" aria-label="gitea" target="_blank" rel="noopener" data-v-e71e869c data-v-60a9a2d3><span class="vpi-social-gitea"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-9fd4d1dd data-v-f953d92f data-v-bfe7971f><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-bfe7971f><span class="vpi-more-horizontal icon" data-v-bfe7971f></span></button><div class="menu" data-v-bfe7971f><div class="VPMenu" data-v-bfe7971f data-v-20ed86d6><!----><!--[--><!--[--><!----><div class="group" data-v-f953d92f><div class="item appearance" data-v-f953d92f><p class="label" data-v-f953d92f>Appearance</p><div class="appearance-action" data-v-f953d92f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-f953d92f data-v-be9742d9 data-v-b4ccac88><span class="check" data-v-b4ccac88><span class="icon" data-v-b4ccac88><!--[--><span class="vpi-sun sun" data-v-be9742d9></span><span class="vpi-moon moon" data-v-be9742d9></span><!--]--></span></span></button></div></div></div><div class="group" data-v-f953d92f><div class="item social-links" data-v-f953d92f><div class="VPSocialLinks social-links-list" data-v-f953d92f data-v-e71e869c><!--[--><a class="VPSocialLink no-icon" href="https://gitgud.foo/thegrind/authentikate" aria-label="gitea" target="_blank" rel="noopener" data-v-e71e869c data-v-60a9a2d3><span class="vpi-social-gitea"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-9fd4d1dd data-v-6bee1efd><span class="container" data-v-6bee1efd><span class="top" data-v-6bee1efd></span><span class="middle" data-v-6bee1efd></span><span class="bottom" data-v-6bee1efd></span></span></button></div></div></div></div><div class="divider" data-v-9fd4d1dd><div class="divider-line" data-v-9fd4d1dd></div></div></div><!----></header><!----><!----><div class="VPContent is-home" id="VPContent" data-v-d8b57b2d data-v-9a6c75ad><div class="VPHome" data-v-9a6c75ad data-v-e07eaea7><!--[--><!--]--><div class="VPHero VPHomeHero" data-v-e07eaea7 data-v-dd8814ff><div class="container" data-v-dd8814ff><div class="main" data-v-dd8814ff><!--[--><!--]--><!--[--><h1 class="heading" data-v-dd8814ff><span class="name clip" data-v-dd8814ff>AuthentiKate</span><!----></h1><p class="tagline" data-v-dd8814ff>The OIDC/SSO solution for homelabbers</p><!--]--><!--[--><!--]--><div class="actions" data-v-dd8814ff><!--[--><div class="action" data-v-dd8814ff><a class="VPButton medium brand" href="/quick-start/" data-v-dd8814ff data-v-93dc4167>Get Started</a></div><!--]--></div><!--[--><!--]--></div><!----></div></div><!--[--><!--]--><!--[--><!--]--><!----><!--[--><!--]--><div class="vp-doc container" style="" data-v-e07eaea7 data-v-c141a4bd><!--[--><div style="position:relative;" data-v-e07eaea7><div><img src="/screenshots/dashboard.png" alt="Banner" class="w-full h-auto !mb-8"><p><strong>AuthentiKate</strong> is a sleek, self-hosted OpenID Connect (OIDC) provider built with Laravel. It&#39;s designed for developers and homelabbers who want full control over their identity infrastructure — without the bloat.</p><h2 id="🧠-why-authentikate" tabindex="-1">🧠 Why AuthentiKate? <a class="header-anchor" href="#🧠-why-authentikate" aria-label="Permalink to &quot;🧠 Why AuthentiKate?&quot;"></a></h2><p>Modern authentication systems like <strong>Authentik</strong> and <strong>Authelia</strong> offer a lot — sometimes too much. They come with steep learning curves, heavy dependencies, and opinionated workflows that often get in your way.</p><p><strong>AuthentiKate is different.</strong> It gives you:</p><div class="grid md:grid-cols-2 gap-4 my-6"><div class="bg-green-50 p-4 rounded-lg border-l-4 border-green-400"><div class="text-green-700 font-semibold">✅ True minimalism</div><div class="text-green-600 text-sm">No unnecessary services, just Laravel + Livewire</div></div><div class="bg-blue-50 p-4 rounded-lg border-l-4 border-blue-400"><div class="text-blue-700 font-semibold">🔧 Full customization</div><div class="text-blue-600 text-sm">Tailor every flow, token, and screen to your needs</div></div><div class="bg-purple-50 p-4 rounded-lg border-l-4 border-purple-400"><div class="text-purple-700 font-semibold">🛠️ Developer-first design</div><div class="text-purple-600 text-sm">Clear, auditable code with no magic</div></div><div class="bg-pink-50 p-4 rounded-lg border-l-4 border-pink-400"><div class="text-pink-700 font-semibold">📦 Lightweight and self-contained</div><div class="text-pink-600 text-sm">Deploy in seconds, integrate in minutes</div></div></div><h2 id="✨-features" tabindex="-1">✨ Features <a class="header-anchor" href="#✨-features" aria-label="Permalink to &quot;✨ Features&quot;"></a></h2><ul><li>🔐 Full <strong>OIDC Authorization Code flow</strong> with PKCE</li><li>🪙 Signed <strong>Access</strong> and <strong>ID tokens</strong> (RS256)</li><li>📘 <strong>OIDC Discovery</strong> + JWKS endpoints</li><li>👤 <strong>UserInfo endpoint</strong> with name, email, avatar, and custom claims</li><li>💾 DB-backed token storage with per-client scoping</li><li>🧼 Clean, Livewire-powered UI for login and consent</li><li>🎨 Supports branding, theming, and custom domains</li><li>🚀 Integrates easily with Outline, Linkwarden, and any OIDC-compliant app</li></ul><h2 id="🚧-roadmap" tabindex="-1">🚧 Roadmap <a class="header-anchor" href="#🚧-roadmap" aria-label="Permalink to &quot;🚧 Roadmap&quot;"></a></h2><ul><li>🔄 Refresh Token Support</li><li>✅ Email Verification &amp; MFA</li></ul><h2 id="🔍-use-cases" tabindex="-1">🔍 Use Cases <a class="header-anchor" href="#🔍-use-cases" aria-label="Permalink to &quot;🔍 Use Cases&quot;"></a></h2><ul><li>Homelab authentication (SSO for your self-hosted services)</li><li>Lightweight OIDC for internal SaaS apps</li><li>Identity proxy for dev environments</li><li>Custom branding for white-labeled auth flows</li></ul><hr></div></div><!--]--></div></div></div><!----><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"index.md\":\"CrUm1VXh\",\"quick-start_index.md\":\"Drk5n9FD\",\"quick-start_manual-deployment.md\":\"ByuLEmai\",\"user-guide_configuration.md\":\"B_Y1HT-M\",\"user-guide_index.md\":\"Dv1GmQNv\",\"user-guide_installation.md\":\"D00gDZzA\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"AuthentiKate\",\"description\":\"The OIDC/SSO solution for homelabbers\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick Start\",\"link\":\"/quick-start/\"}],\"search\":{\"provider\":\"local\"},\"sidebar\":{\"/quick-start/\":[{\"text\":\"Quick Start\",\"items\":[{\"text\":\"Docker Installation\",\"link\":\"/quick-start/\"},{\"text\":\"Manual Deployment\",\"link\":\"/quick-start/manual-deployment\"}]}]},\"socialLinks\":[{\"icon\":\"gitea\",\"link\":\"https://gitgud.foo/thegrind/authentikate\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
</body>
</html>