Authenti

OliveTin · Oct 26, 2024 · 91cd486 · 91cd486
1 parent 0a95584
commit 91cd486
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 0 deletions.
diff --git a/modules/ROOT/pages/security/authentik_new_app.png b/modules/ROOT/pages/security/authentik_new_app.png
diff --git a/modules/ROOT/pages/security/authentik_provider_config.png b/modules/ROOT/pages/security/authentik_provider_config.png
diff --git a/modules/ROOT/pages/security/authentik_provider_secrets.png b/modules/ROOT/pages/security/authentik_provider_secrets.png
diff --git a/modules/ROOT/pages/security/authentik_select_oauth2.png b/modules/ROOT/pages/security/authentik_select_oauth2.png
diff --git a/modules/ROOT/pages/security/oauth2_authentik.adoc b/modules/ROOT/pages/security/oauth2_authentik.adoc
@@ -0,0 +1,53 @@
+[#oauth2-authentik]
+=== Authentik (OAuth2)
+
+OliveTin has been tested with Authentik. This documentation page describes how to configure Authentik for use with OliveTin and assumes you already have Authentik installed and running.
+
+Login as an Authentik administrator and start by creating a new app as follows;
+
+image::authentik_new_app.png[]
+
+Click Next, and on the **Provider Type** page select **OAuth2**.
+
+image::authentik_select_oauth2.png[]
+
+Click Next, and on the **Provider Configuration** page, fill in the following fields;
+
+image::authentik_provider_config.png[]
+
+Scroll down, and on the same page, copy the **Client ID** and **Client Secret** fields. You will need these to configure OliveTin.
+
+image::authentik_provider_secrets.png[]
+
+Submit this wizard to save the configuration.
+
+==== OliveTin configuration
+
+The necessary OliveTin configuration is as follows;
+
+```yaml
+authOAuth2RedirectURL: "http://localhost:1337/oauth/callback"
+authOAuth2Providers:
+  authentik:
+    name: authentik
+    title: Authentik
+    clientID: "1234567890"
+    clientSecret: "123456789012345"
+    authURL: "http://localhost:9000/application/o/authorize/"
+    tokenURL: "http://localhost:9000/application/o/token/"
+    whoamiURL: "http://localhost:9000/application/o/userinfo/"
+    usernameField: "preferred_username"
+    icon: <iconify-icon icon="simple-icons:authentik"></iconify-icon>
+```
+
+You will need to restart OliveTin for the changes to take effect.
+
+==== Testing
+
+You should now be able to login to OliveTin using Authentik, on the OliveTin page, a "Login" link should be available in the top right corner. This will take you to the login form, where you can select the Authentik provider.
+
+
+=== Debugging
+
+OliveTin logs OAuth2 flows quite extensively. If you are having trouble with OAuth2, you should check your OliveTin logs. 
+