burritosoftware/outline-authentik-connector repository overview

⁠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⁠! I created this for internal use at WiiLink⁠ 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⁠ or manually⁠.

⁠Docker Setup

The connector can be deployed with Docker Compose for quick and easy setup.

1. Grab the docker-compose.yml file here⁠, as well as the .env.example file here⁠.
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.

pip3 install -r requirements.txt

1. Copy the environment configuration, and fill it in with your Authentik and Outline configuration.

cp .env.example .env
nano .env

1. Start the connector.

fastapi run connect.py --port 8430

1. Use a reverse proxy to proxy the connector to a subdomain with HTTPS.