This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/outpost/README.md

1.6 KiB

authentik outpost

CI Build status Docker pulls (proxy) Docker pulls (ldap)

Reverse Proxy based on oauth2_proxy, completely managed and monitored by authentik.

LDAP Server using ldap, completely managed and monitored by authentik.

Usage

authentik Outpost is built to be configured by authentik itself, hence the only options you can directly give it are connection params.

The following environment variable are implemented:

AUTHENTIK_HOST: Full URL to the authentik instance with protocol, i.e. "https://authentik.company.tld"

AUTHENTIK_TOKEN: Token used to authenticate against authentik. This is generated after an Outpost instance is created.

AUTHENTIK_INSECURE: This environment variable can optionally be set to ignore the SSL Certificate of the authentik instance. Applies to both HTTP and WS connections.

Development

authentik outpost uses an auto-generated API Client to communicate with authentik. This client is not kept in git. To generate the client locally, run make gen-outpost in the root directory of the repo.

Afterwards you can build the outpost like any other Go project, using go build ./cmd/proxy/server.go or go build ./cmd/ldap/server.go.