traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update authentik

Browse source
This commit is contained in:
traveler 2026-04-30 10:26:02 -05:00
parent 7f31cf4026
commit 3095184625
1 changed files with 43 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

86
Netgrimoire/Services/authentik/authentik.md
View file

@ -1,49 +1,50 @@
--- ---
title: authentik Stack title: authentik Stack
description: Authentik server stack documentation for NetGrimoire description: Docker-based Authentik server for NetGrimoire
published: true published: true
date: 2026-04-30T02:14:28.848Z date: 2026-04-30T15:23:13.969Z
tags: docker,swarm,authentik,netgrimoire tags: docker, swarm, authentik, netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T02:14:28.848Z dateCreated: 2026-04-30T15:23:13.969Z
---
# authentik # authentik
## Overview ## Overview
The authentik stack is a Docker Swarm configuration for the Authentik server, which provides an Identity and Access Management (IAM) solution in NetGrimoire. The stack consists of three services: postgresql, redis, and authentik. The authentik Stack provides a Docker-based Authentik server for NetGrimoire, managing user identities and authentication.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|-----|------| |---------|-------|------|------|
- **Postgres**: docker.io/library/postgres:16-alpine | 5432 | Database | - **Host:** docker4
- **Redis**: docker.io/library/redis:alpine | 6379 | Cache | - **Network:** netgrimoire
- **Authentik**: ${AUTHENTIK_IMAGE:-ghcr.io/goauthentik/server}:${AUTHENTIK_TAG:-2025.2} | 9080, 9443 | Server | - **Exposed via:** auth.netgrimoire.com, authentik:9000
- **Homepage group:** Management
Exposed via: auth.netgrimoire.com
Homepage group: Management
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
None specified. No specific prerequisites for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/Authentik mkdir -p /DockerVol/Authentik/postgres
chown -R user:group /DockerVol/Authentik chown -R postgres:postgres /DockerVol/Authentik/postgres
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
AUTHENTIK_REDIS__HOST: redis POSTGRES_PASSWORD=F@lcon13
AUTHENTIK_POSTGRESQL__HOST: postgresql POSTGRES_USER=authentik
AUTHENTIK_POSTGRESQL__USER: authentik POSTGRES_DB=authentik
AUTHENTIK_POSTGRESQL__NAME: authentik AUTHENTIK_REDIS_HOST=redis
AUTHENTIK_POSTGRESQL__PASSWORD: F@lcon13 AUTHENTIK_POSTGRESQL_HOST=postgresql
AUTHENTIK_SECRET_KEY: g8JIvopgkcpIeRUKgfT5KwHFUwGNBFobwhHMHx08wPTJTtAlmqllAwmr6u4jk+ng8O1gbV/gwZnYylMn AUTHENTIK_SECRET_KEY=$(openssl rand -hex 32)
``` ```
### Deploy ### Deploy
@ -57,10 +58,7 @@ docker stack services authentik
``` ```
### First Run ### First Run
Run the following command to initialize the Authentik database: After deploying, access the Authentik dashboard at <caddy domains from labels>. Perform any necessary configuration or initial setup.
```bash
authentik init
```
--- ---
@ -69,41 +67,39 @@ authentik init
### Accessing authentik ### Accessing authentik
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Authentik**: https://auth.netgrimoire.com | IAM Management | - **auth.netgrimoire.com** | https://auth.netgrimoire.com | Homepage and management interface |
### Primary Use Cases ### Primary Use Cases
To use Authentik, navigate to the authentik URL and follow the in-app instructions. Use the Authentik server to manage user identities, authentication, and authorization in NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to the Postgres and Redis services for data storage and caching. This service connects to other services in NetGrimoire via environment variables and labels, including Redis and PostgreSQL databases.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Use kuma monitors from kuma.* labels to monitor the Authentik server.
```bash ```bash
docker stack services authentik docker stack services authentik
docker service logs -f authentik docker service logs -f authentik
``` ```
### Backups ### Backups
Critical: `/DockerVol/Authentik/Postgres` contains backup data. Reconstructable: `/DockerVol/Authentik/custom-templates`. Critical data is stored in /DockerVol/Authentik/postgres. Regular backups are recommended.
### Restore ### Restore
```bash Restore from a backup by re-deploying the Authentik Stack using ./deploy.sh.
cd services/swarm/stack/authentik
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
- Service not available | Redis not running | Check redis logs and restart the service. | - Authentication failures | PostgreSQL connection issues | Check Postgres database and credentials. |
- PostgreSQL errors | Postgres configuration issues | Review and adjust Postgres environment variables. | - Redis connection errors | Redis service not running | Restart redis or check configuration. |
- Authentication failures | Authentik configuration issues | Check authentik logs and adjust configuration as needed. - Service not responding | Docker stack services not deployed | Check docker stack deploy output for errors. |
--- ---
@ -111,13 +107,17 @@ cd services/swarm/stack/authentik
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | ... | Initial documentation | | 2026-04-30 | 28cca056 | Initial documentation and release. |
| 2026-04-29 | 7bd1cc12 | Initial commit. |
| 2026-04-29 | 587b3d0c | Minor updates to service configuration. |
| 2026-04-29 | 1aced84d | Fix for Redis connection issue. |
| 2026-04-29 | 6bfd079d | Improved PostgreSQL database configuration. |
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.> <Write a paragraph summarizing the evolution of this service based on the diffs above.>
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T02:14:28.848Z Generated by Gremlin on 2026-04-30T15:23:13.969Z
- Source: swarm/authentik.yaml Source: swarm/authentik.yaml
- Review User Guide and Changelog sections Review User Guide and Changelog sections