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/proxy/README.md

25 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2020-12-05 21:08:42 +00:00
# authentik Proxy
2020-09-02 22:04:12 +00:00
2020-12-05 21:08:42 +00:00
[![CI Build status](https://img.shields.io/azure-devops/build/beryjuorg/authentik/3?style=flat-square)](https://dev.azure.com/beryjuorg/authentik/_build?definitionId=3)
![Docker pulls (proxy)](https://img.shields.io/docker/pulls/beryju/authentik-proxy.svg?style=flat-square)
2020-09-02 22:04:12 +00:00
2020-12-05 21:08:42 +00:00
Reverse Proxy based on [oauth2_proxy](https://github.com/oauth2-proxy/oauth2-proxy), completely managed and monitored by authentik.
2020-09-02 22:04:12 +00:00
## Usage
2020-12-05 21:08:42 +00:00
authentik Proxy is built to be configured by authentik itself, hence the only options you can directly give it are connection params.
2020-09-02 22:04:12 +00:00
The following environment variable are implemented:
2020-12-05 21:08:42 +00:00
`AUTHENTIK_HOST`: Full URL to the authentik instance with protocol, i.e. "https://authentik.company.tld"
2020-09-02 22:04:12 +00:00
2020-12-05 21:08:42 +00:00
`AUTHENTIK_TOKEN`: Token used to authenticate against authentik. This is generated after an Outpost instance is created.
2020-09-02 22:04:12 +00:00
2020-12-05 21:08:42 +00:00
`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.
2020-09-02 22:04:12 +00:00
## Development
2020-12-05 21:08:42 +00:00
authentik Proxy uses an auto-generated API Client to communicate with authentik. This client is not kept in git. To generate the client locally, run `make generate`.
2020-09-02 22:04:12 +00:00
Afterwards you can build the proxy like any other Go project, using `go build`.