mirror of
https://github.com/derfenix/webarchive.git
synced 2026-03-11 22:40:58 +03:00
84 lines
2.0 KiB
Markdown
84 lines
2.0 KiB
Markdown
# Own Webarchive
|
|
|
|
Aimed to be a simple, fast and easy-to-use webarchive for personal or home-net usage.
|
|
|
|
## Requirements
|
|
|
|
* Golang 1.19 or higher
|
|
* wkhtmltopdf binary in $PATH (to save pages in pdf)
|
|
|
|
## Configuration
|
|
|
|
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`)
|
|
|
|
|
|
*Note*: Prefix **WEBARCHIVE_** can be used with the environment variable names
|
|
in case of any conflicts.
|
|
|
|
## Usage
|
|
|
|
#### 1. Start the server
|
|
|
|
```shell
|
|
go run ./cmd/server/main.go
|
|
```
|
|
|
|
#### 2. Add a page
|
|
|
|
```shell
|
|
curl -X POST --location "http://localhost:5001/pages" \
|
|
-H "Content-Type: application/json" \
|
|
-d "{
|
|
\"url\": \"https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1937\",
|
|
\"formats\": [
|
|
\"pdf\",
|
|
\"headers\"
|
|
]
|
|
}" | jq .
|
|
```
|
|
|
|
or
|
|
|
|
```shell
|
|
curl -X POST --location \
|
|
"http://localhost:5001/pages?url=https%3A%2F%2Fgithub.com%2Fwkhtmltopdf%2Fwkhtmltopdf%2Fissues%2F1937&formats=pdf%2Cheaders&description=Foo+Bar"
|
|
```
|
|
|
|
#### 3. Get the page's info
|
|
|
|
```shell
|
|
curl -X GET --location "http://localhost:5001/pages/$page_id" | jq .
|
|
```
|
|
where `$page_id` — value of the `id` field from previous command response.
|
|
If `status` field in response is `success` (or `with_errors`) - the `results` field
|
|
will contain all processed formats with ids of the stored files.
|
|
|
|
#### 4. Open file in browser
|
|
|
|
```shell
|
|
xdg-open "http://localhost:5001/pages/$page_id/file/$file_id"
|
|
```
|
|
Where `$page_id` — value of the `id` field from previous command response, and
|
|
`$file_id` — the id of interesting file.
|
|
|
|
#### 5. List all stored pages
|
|
|
|
```shell
|
|
curl -X GET --location "http://localhost:5001/pages" | jq .
|
|
```
|
|
|
|
### Roadmap
|
|
|
|
- [x] Save page to pdf
|
|
- [x] Save URL headers
|
|
- [ ] Save page to the single-page html
|
|
- [ ] Save page to html with separate resource files (?)
|
|
- [ ] Optional authentication
|
|
- [ ] Multi-user access
|
|
- [ ] Support PostgreSQL
|
|
- [ ] Extend configuration
|