mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-30 17:50:04 +02:00
Code Issues Releases Wiki Activity

Updated Usage (markdown)

Nick Sweeting
2019-03-12 19:43:31 -04:00
parent 9a64d3d933
commit 406a865ce2
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Usage.md

@@ -21,6 +21,15 @@
If you're using Docker, the CLI interface is similar but needs to be prefixed by `docker-compose exec ...` or `docker run ...`, for examples see the [[Docker]] page.
- [Run ArchiveBox with configuration options](#Run-ArchiveBox-with-configuration-options)
- [Import a single URL or list of URLs via stdin](#Import-a-single-URL-or-list-of-URLs-via-stdin)
- [Import list of links exported from browser or another service](#Import-list-of-links-exported-from-browser-or-another-service)
- [Import list of URLs from a remote RSS feed or file](#Import-list-of-URLs-from-a-remote-RSS-feed-or-file)
- [Import list of links from browser history](#Import-list-of-links-from-browser-history)
- [UI Usage](#UI-Usage)
---
### Run ArchiveBox with configuration options
You can set environment variables in your shell profile, a config file, or by using the `env` command.
@@ -30,6 +39,8 @@ env FETCH_MEDIA=True MEDIA_TIMEOUT=500 ./archive ...
See [[Configuration]] page for more details about the available options and ways to pass config.
If you're using Docker, also make sure to read the Configuration section on the [[Docker]] page.
---
### Import a single URL or list of URLs via stdin
```bash
echo 'https://example.com' | ./archive
@@ -38,6 +49,8 @@ cat urls_to_archive.txt | ./archive
```
You can also pipe in RSS, XML, Netscape, or any of the other supported import formats via stdin.
---
### Import list of links exported from browser or another service
```bash
@@ -50,6 +63,8 @@ You can also pipe in RSS, XML, Netscape, or any of the other supported import fo
Passing a file as an argument here does not archive the file, it parses it as a list of URLs and archives the links *inside of it*, so only use it for *lists of links* to archive, not HTML files or other content you want added directy to the archive.
---
### Import list of URLs from a remote RSS feed or file
ArchiveBox will download the URL to a local file in `output/sources/` and attempt to autodetect the format and import any URLs found. Currently, Netscape HTML, JSON, RSS, and plain text links lists are supported.
@@ -61,6 +76,8 @@ ArchiveBox will download the URL to a local file in `output/sources/` and attemp
Passing a URL as an argument here does not archive the specified URL, it downloads it and archives the links *inside* of it, so only use it for RSS feeds or other *lists of links* you want to add. To add an individual link use the instruction above and pass the URL via stdin instead of as an argument.
---
### Import list of links from browser history
```bash
./bin/archivebox-export-browser-history --chrome
@@ -70,6 +87,8 @@ Passing a URL as an argument here does not archive the specified URL, it downloa
./archive output/sources/firefox_history.json
```
---
### UI Usage
To access your archive, open `output/index.html` in a browser. You should see something [like this](https://archive.sweeting.me).