From ae76f9464f2f64018548f4ddfe7b94b92616c6dd Mon Sep 17 00:00:00 2001 From: Mohamed Bassem Date: Sun, 13 Apr 2025 16:18:09 +0000 Subject: docs: Release the new API docs --- .../version-v0.23.2/14-Guides/03-singlefile.md | 30 ++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/versioned_docs/version-v0.23.2/14-Guides/03-singlefile.md (limited to 'docs/versioned_docs/version-v0.23.2/14-Guides/03-singlefile.md') diff --git a/docs/versioned_docs/version-v0.23.2/14-Guides/03-singlefile.md b/docs/versioned_docs/version-v0.23.2/14-Guides/03-singlefile.md new file mode 100644 index 00000000..522caf50 --- /dev/null +++ b/docs/versioned_docs/version-v0.23.2/14-Guides/03-singlefile.md @@ -0,0 +1,30 @@ +# Using Hoarder with SingleFile Extension + +Hoarder supports being a destination for the [SingleFile extension](https://github.com/gildas-lormeau/SingleFile). This has the benefit of allowing you to use the singlefile extension to hoard links as you're seeing them in the browser. This is perfect for websites that don't like to get crawled, has annoying cookie banner or require authentication. + +## Setup + +1. Install the [SingleFile extension](https://github.com/gildas-lormeau/SingleFile). +2. In the extension settings, select `Destinations`. +3. Select `upload to a REST Form API`. +4. In the URL, insert the address: `https://YOUR_SERVER_ADDRESS/api/v1/bookmarks/singlefile`. +5. In the `authorization token` field, paste an API key that you can get from your hoarder settings. +6. Set `data field name` to `file`. +7. Set `URL field name` to `url`. + +Now, go to any page and click the singlefile extension icon. Once it's done with the upload, the bookmark should show up in your hoarder instance. Note that the singlefile extension doesn't show any progress on the upload. Given that archives are typically large, it might take 30+ seconds until the upload is done and starts showing up in Hoarder. + + +## Recommended settings + +In the singlefile extension, you probably will want to change the following settings for better experience: +* Stylesheets > compress CSS content: on +* Stylesheets > group duplicate stylesheets together: on +* HTML content > remove frames: on + +Also, you most likely will want to change the default `MAX_ASSET_SIZE_MB` in hoarder to something higher, for example `100`. + +:::info +Currently, we don't support screenshots for singlefile uploads, but this will change in the future. +::: + -- cgit v1.2.3-70-g09d2