mirror of
https://github.com/wrolpi/wrolpi-help.git
synced 2026-10-26 02:48:45 -04:00
Adding documents for the new SingleFile browser extension feature.
This commit is contained in:
parent
771cf2da11
commit
1da973c4c3
7 changed files with 67 additions and 0 deletions
BIN
docs/modules/archives/archive-settings-page.png
Normal file
BIN
docs/modules/archives/archive-settings-page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
BIN
docs/modules/archives/archive-uploaded-notification.png
Normal file
BIN
docs/modules/archives/archive-uploaded-notification.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
docs/modules/archives/firefox-singlefile-settings.png
Normal file
BIN
docs/modules/archives/firefox-singlefile-settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
|
|
@ -42,3 +42,8 @@ When the indexes for an Archive are generated for searching, they are searched i
|
|||
1. Title
|
||||
2. HTML Metadata Description
|
||||
3. Readability Text
|
||||
|
||||
## My Archive Download Fails
|
||||
|
||||
If your Archive download repeatedly fails, you can manually archive a webpage using the SingleFile browser extension.
|
||||
See this detailed page: [SingleFile Browser Extension](singlefile-extension.md)
|
||||
BIN
docs/modules/archives/singlefile-extension-ok.png
Normal file
BIN
docs/modules/archives/singlefile-extension-ok.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 789 B |
62
docs/modules/archives/singlefile-extension.md
Normal file
62
docs/modules/archives/singlefile-extension.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# SingleFile Browser Extension
|
||||
|
||||
Archives in WROLPi are made from a [SingleFile](https://github.com/gildas-lormeau/SingleFile). The project offers
|
||||
browser extensions which can be used to manually archive a webpage.
|
||||
|
||||
The extension can be configured to upload any page you archive to your WROLPi. WROLPi will convert the singlefile to an
|
||||
Archive by extracting the readability, screenshot, etc.
|
||||
|
||||
## Browser Extensions
|
||||
|
||||
* [Firefox](https://addons.mozilla.org/en-US/firefox/addon/single-file/)
|
||||
* [Chrome](https://chromewebstore.google.com/detail/singlefile/mpiodijhokgodhhofbcjdecpffjipkle)
|
||||
* [Safari](https://apps.apple.com/us/app/singlefile-for-safari/id6444322545)
|
||||
* [Edge](https://microsoftedge.microsoft.com/addons/detail/singlefile/efnbkdcfmcmnhlkaijjjmhjjgladedno)
|
||||
|
||||
## Configure Browser Extensions
|
||||
|
||||
### Firefox
|
||||
|
||||
1. Install the [addon](https://addons.mozilla.org/en-US/firefox/addon/single-file/)
|
||||
2. Navigate to: `about:addons`, or, **Menu** > **Add-ons and Themes** > **Extensions**
|
||||
3. Open the **SingleFile** extension header.
|
||||
4. Open the **Preferences** Tab.
|
||||
5. Open the **Destination** row.
|
||||
6. Scroll to the bottom and enter the following fields:
|
||||
1. In a separate tab, open your WROLPi web interface, navigate to **Archive** > **Settings**.
|
||||
* 
|
||||
2. Copy the **Upload URL**, paste it into **upload to REST Form API** > `URL`
|
||||
* Note: Your URL will be different depending on the IP address or hostname of your WROLPi.
|
||||
3. Copy the **Data Field Name**, paste it into **upload to REST Form API** > `archive data field name`
|
||||
4. Copy the **URL Field Name**, paste it into the **upload to REST Form API** > `archive URL field name`
|
||||
5. The configured extension:
|
||||
* 
|
||||
|
||||
### Chrome
|
||||
|
||||
1. Install the [extension](https://chromewebstore.google.com/detail/singlefile/mpiodijhokgodhhofbcjdecpffjipkle)
|
||||
2. Navigate to `chrome://extensions`, or, **Menu** > **Extensions** > **Manage Extensions**
|
||||
3. Click the **SingleFile** extension **details** button.
|
||||
4. Open the **Extension Options** popup.
|
||||
5. Open the **Destination** row.
|
||||
6. Scroll to the bottom and enter the following fields:
|
||||
1. In a separate tab, open your WROLPi web interface, navigate to **Archive** > **Settings**.
|
||||
* 
|
||||
2. Copy the **Upload URL**, paste it into **upload to REST Form API** > `URL`
|
||||
* Note: Your URL will be different depending on the IP address or hostname of your WROLPi.
|
||||
3. Copy the **Data Field Name**, paste it into **upload to REST Form API** > `archive data field name`
|
||||
4. Copy the **URL Field Name**, paste it into the **upload to REST Form API** > `archive URL field name`
|
||||
5. The configured extension:
|
||||
* 
|
||||
|
||||
## How to archive using the SingleFile extension
|
||||
|
||||
Using the SingleFile extension is simple, follow these steps:
|
||||
|
||||
1. Navigate to a webpage you want to archive.
|
||||
2. Click the SingleFile extension icon, you will see a progress indicator on the bottom-left of the webpage:
|
||||
* 
|
||||
3. The SingleFile extension will show an **OK** after uploading:
|
||||
* 
|
||||
4. Your WROLPi will process the SingleFile, eventually a notification will be displayed in your WROLPi interface:
|
||||
* 
|
||||
BIN
docs/modules/archives/singlefile-progress-indicator.png
Normal file
BIN
docs/modules/archives/singlefile-progress-indicator.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.4 KiB |
Loading…
Add table
Add a link
Reference in a new issue