fenix/webarchive
1
0
Fork 0
mirror of https://github.com/derfenix/webarchive.git synced 2026-03-11 12:41:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Extend configuration

Browse Source
This commit is contained in:
derFenix
2023-03-28 21:07:42 +03:00
parent 6839a264db
commit 8d2af4ad65
7 changed files with 63 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -12,8 +12,20 @@ Aimed to be a simple, fast and easy-to-use webarchive for personal or home-net u
The service can be configured via environment variables. There is a list of available
variables:
* **DB_PATH** — path for the database files (default `./db`)
* **LOGGING_DEBUG** — enable debug logs (default `false`)
* **DB**
* **DB_PATH** — path for the database files (default `./db`)
* **LOGGING**
* **LOGGING_DEBUG** — enable debug logs (default `false`)
* **API**
* **API_ADDRESS** — address the API server will listen (default `0.0.0.0:5001`)
* **PDF**
* **PDF_LANDSCAPE** — use landscape page orientation instead of portrait (default `false`)
* **PDF_GRAYSCALE** — use grayscale filter for the output pdf (default `false`)
* **PDF_MEDIA_PRINT** — use media type `print` for the request (default `true`)
* **PDF_ZOOM** — zoom page (default `1.0` i.e. no actual zoom)
* **PDF_VIEWPORT** — use specified viewport value (default `1920x1080`)
* **PDF_DPI** — use specified DPI value for the output pdf (default `300`)
* **PDF_FILENAME** — use specified name for output pdf file (default `page.pdf`)
*Note*: Prefix **WEBARCHIVE_** can be used with the environment variable names
@@ -80,4 +92,3 @@ curl -X GET --location "http://localhost:5001/pages" | jq .
- [ ] Optional authentication
- [ ] Multi-user access
- [ ] Support PostgreSQL
- [ ] Extend configuration