https://github.com/burritosoftware/outline-authentik-connector
Syncs groups between Authentik and Outline
https://github.com/burritosoftware/outline-authentik-connector
Last synced: 12 months ago
JSON representation
Syncs groups between Authentik and Outline
- Host: GitHub
- URL: https://github.com/burritosoftware/outline-authentik-connector
- Owner: burritosoftware
- License: gpl-3.0
- Created: 2024-06-21T00:38:42.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T21:36:40.000Z (almost 2 years ago)
- Last Synced: 2025-08-17T00:42:02.821Z (12 months ago)
- Language: Python
- Size: 47.9 KB
- Stars: 7
- Watchers: 2
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Outline Authentik Connector
[](https://wakatime.com/badge/github/burritosoftware/Outline-Authentik-Connector) [](https://hub.docker.com/r/burritosoftware/outline-authentik-connector)
Syncs groups between Authentik and Outline. Users will be added/removed from Outline groups depending on what Authentik groups they're in, on each sign in.
This was inspired by [this similar connector for Outline and Keycloak](https://gist.github.com/Frando/aa561ca7e6c72ab64b5d17df911c0b1f)! I created this for internal use at [WiiLink](https://github.com/WiiLink24) and to learn FastAPI and Docker.
## How It Works
Outline groups that are named the same as Authentik groups will be linked together. Users who are in an Authentik group but not in a linked Outline group will be added to the Outline group. Conversely, if a user is not in a linked Authentik group, but is in an Outline group, they will be removed from that group.
This connector listens for `users.signin` webhook events from Outline. Once a user signs into Outline, this connector will check for matching groups, and add/remove the user to those groups accordingly.
## Requirements
- Outline API key
- Authentik API key
- Reverse proxy to apply HTTPS
- Python 3.11.1 or higher (not required if using Docker)
- Docker and Docker Compose (optional)
## Outline Setup
1. Login to your Outline instance. Click your profile in the bottom left, then go to **Preferences**.
2. On the sidebar, click **API**. At the top right, select **New API Key...**, and give it a name like `Outline Authentik Connector`.
3. Save the API key somewhere safe to fill in later.
4. On the sidebar, click **Webhooks**. At the top right, select **New webhook...**, and give it a name like `Outline Authentik Connector`. Copy the signing secret and save it somewhere safe to fill in later.
5. Enter in the URL of a subdomain you plan to host the connector on, and **make sure it ends in `/sync`. This is important.** Then, tick the box for **users.signin**, and then scroll all the way down and click **Create**.
## Authentik Setup
1. Login to your Authentik instance, and access the **Admin interface**.
2. On the sidebar, go to **Users**, and then **Create Service account**. Turn off **Create group** and **Expiring** unless you want to rotate the token manually after expiry. Give it a username and create the account.
3. Find your newly created service account, go to **Permissions**, and under **Assigned global permissions**, search for and assign the permissions `Can view Group` and `Can view User`.
4. Go back to **Overview** and select to **Impersonate**.
5. Go to the settings gear in the top right, then go to **Tokens and App passwords**. Click the **Create Token** button.
6. Set an identifier for the token, and optionally, a description.
7. Click **Copy token** next to the token you made, and save it somewhere safe to fill in later.
Now, choose whether to setup the connector [with Docker](#docker-setup) or [manually](#manual-setup).
## Docker Setup
The connector can be deployed with Docker Compose for quick and easy setup.
1. [Grab the `docker-compose.yml` file here](./docker-compose.yml), as well as [the `.env.example` file here](./.env.example).
2. Change `.env.example` to `.env`, and fill it in with your Authentik and Outline configuration.
3. Start the connector with `docker compose up -d`. By default, the connector will be exposed on port `8430`.
4. Use a reverse proxy to proxy the connector to a subdomain with HTTPS.
## Manual Setup
1. Install requirements.
```sh
pip3 install -r requirements.txt
```
2. Copy the environment configuration, and fill it in with your Authentik and Outline configuration.
```sh
cp .env.example .env
nano .env
```
3. Start the connector.
```sh
fastapi run connect.py --port 8430
```
4. Use a reverse proxy to proxy the connector to a subdomain with HTTPS.