Skip to content

Commit 114dd5d

Browse files
author
mirkobrombin
committed
docs: document AuthPlugin
1 parent e7088cf commit 114dd5d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ The following plugins are included:
172172

173173
- **Custom Header Plugin**: Adds custom headers to HTTP responses, configured per domain.
174174
- **PHP Plugin**: Handles `.php` requests using PHP-FPM.
175+
- **AuthPlugin**: Protects routes with basic authentication.
175176

176177
### Enabling Plugins
177178

@@ -190,6 +191,14 @@ the site's JSON configuration file. Example:
190191
"PHPPlugin": {
191192
"enable": true,
192193
"fpm_addr": "/run/php/php8.2-fpm.sock"
194+
},
195+
"AuthPlugin": {
196+
"protected_paths": ["/protected.html"],
197+
"credentials": {
198+
"admin": "password123",
199+
"user": "userpass"
200+
},
201+
"session_expiration": 3600
193202
}
194203
}
195204
}

0 commit comments

Comments
 (0)