A tiny HTTP server to be used as external authentication service for Envoy
Life is hard, but beautiful
As almost every configuration parameter can be defined in environment vars, there are only few flags that can be defined. They are described in the following table:
| Name | Description | Default | Example |
|---|---|---|---|
--log-level |
Verbosity level for logs | info |
--log-level info |
--disable-trace |
Disable showing traces in logs | info |
--log-level info |
--config |
Path to the configuration file Config Example |
doorkeeper.yaml |
--doorkeeper doorkeeper.yaml |
Output is thrown always in JSON as it is more suitable for automations
doorkeeper run \
--log-level=infoA complete example of the config params can be found in docs/samples/doorkeeper.yaml
This project can be deployed in Kubernetes, but also provides binary files and Docker images to make it easy to be deployed however wanted
Binary files for most popular platforms will be added to the releases
You can deploy doorkeeper in Kubernetes using Helm as follows:
helm repo add doorkeeper https://freepik-company.github.io/doorkeeper/
helm upgrade --install --wait doorkeeper \
--namespace doorkeeper \
--create-namespace freepik-company/doorkeeperMore information and Helm packages here
Docker images can be found in GitHub's packages related to this repository
Do you need it in a different container registry? I think this is not needed, but if I'm wrong, please, let's discuss it in the best place for that: an issue
We are open to external collaborations for this project: improvements, bugfixes, whatever.
For doing it, open an issue to discuss the need of the changes, then:
- Fork the repository
- Make your changes to the code
- Open a PR and wait for review
The code will be reviewed and tested (always)
We are developers and hate bad code. For that reason we ask you the highest quality on each line of code to improve this project on each iteration.
Copyright 2022.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.