mirror of
https://github.com/Garmelon/PFERD.git
synced 2025-07-20 01:42:37 +02:00
Document simple authenticator
This commit is contained in:
11
CONFIG.md
11
CONFIG.md
@@ -104,11 +104,18 @@ authenticators is `type`:
|
|||||||
This crawler crawls a local directory. It is really simple and mostly useful for
|
This crawler crawls a local directory. It is really simple and mostly useful for
|
||||||
testing different setups.
|
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
|
## 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
|
## Transformation rules
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user