From 961f40f9a10d126a7c9a241b29dfcfac3b9ede10 Mon Sep 17 00:00:00 2001 From: Joscha Date: Thu, 13 May 2021 19:55:04 +0200 Subject: [PATCH] Document simple authenticator --- CONFIG.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/CONFIG.md b/CONFIG.md index 16c8531..92c36ae 100644 --- a/CONFIG.md +++ b/CONFIG.md @@ -104,11 +104,18 @@ authenticators is `type`: This crawler crawls a local directory. It is really simple and mostly useful for testing different setups. -- `path`: Path to the local directory to crawl. (No default, must be specified) +- `path`: Path to the local directory to crawl. (Required) ## Authenticator types -TODO Fill in as authenticators are implemented +### The `simple` authenticator + +With this authenticator, the username and password can be set directly in the +config file. If the username or password are not specified, the user is prompted +via the terminal. + +- `username`: The username (Optional) +- `password`: The password (Optional) ## Transformation rules