From ab6bcad51006f60cadd5a13fb185c0c74cecc54a Mon Sep 17 00:00:00 2001 From: Gabriel Simmer Date: Fri, 24 Apr 2020 09:13:06 +0100 Subject: [PATCH] Add blurb about authentication to README. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 22a113b..a1f7c81 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,14 @@ you can find a full configuration file under `assets/config_examples/providers.y custom file providers can be implemented by adding a new go file to the `files` module. it should implement the `FileProviderInterface` interface. +## authentication + +basic authentication support utilizing [keycloak](https://keycloak.org/) has been implemented, but work +is being done to bring this more inline with the storage provider implementation. see `assets/config_examples/auth.yml` +for an example configuration - having this file alongside the binary will activate authentication on all +`/api/files` endpoints. note that this implementation is a work in progress, and a seperate branch will +contain further improvements. + ## icons SVG Icons provided by Paweł Kuna: https://github.com/tabler/tabler-icons (see assets/web/icons/README.md) \ No newline at end of file