Archives/falk-werner_webfuse
1
0
Fork 0
mirror of https://github.com/falk-werner/webfuse synced 2026-10-23 21:28:26 +00:00
Code Issues Releases Wiki Activity

enhance documentation

Browse Source
This commit is contained in:
Falk Werner
2023-01-15 21:00:10 +01:00
parent 8c290b8c02
commit 75905d6480
6 changed files with 141 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/authentication.md Normal file
View File

@@ -0,0 +1,30 @@
# Authentication
Webfuse supports token-based authentication using HTTP headers. To activate authentication, two command line option needs to be given:
- `--wf-authenticator PATH`
allows to specify an executable used for authentication
- `--wf-auth-header HEADER`
allows to specify the HTTP header used for authentication
## Authenticator
An authenticator is an executable or script used for token-based
authentication. During HTTP handshake, webfuse will scan for the
configured HTTP header and invoke the authenticator.
authenticator TOKEN
The provided `token` contains the contents of the HTTP header.
## Header restrictions
Note that not any HTTP header can be specified using `--wf-auth-header`
option. The following headers are supported:
- `X-Auth-Token`
- `Authorization`
In addition to that, any non-standard header can be specified.
Due to implementation limitation, most standard headers can not be used by now. Please let us know, when you intend to use a header that is not supported yet. Please create an issue in that case.