mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-25 07:20:59 +02:00
Code Issues Releases Wiki Activity

Updated Quickstart (markdown)

Nick Sweeting
2018-12-31 20:17:49 -05:00
parent c856c66759
commit b3ad1c1da1
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Quickstart.md

@@ -24,11 +24,15 @@ Follow the links here to find instructions for exporting a list of URLs from eac
**2. Create your archive:** **2. Create your archive:**
Create a folder to store your archive, and clone the ArchiveBox repo into it.
```bash ```bash
git clone https://github.com/pirate/ArchiveBox git clone https://github.com/pirate/ArchiveBox
cd ArchiveBox/ cd ArchiveBox/
./setup # install all dependencies ./setup # install all dependencies
```
Import your list of links:
```
# add a list of links from a file # add a list of links from a file
./archive ~/Downloads/bookmark_export.html # replace with the path to your export file or URL from step 1 ./archive ~/Downloads/bookmark_export.html # replace with the path to your export file or URL from step 1
@@ -43,13 +47,15 @@ cd ArchiveBox/
./archive # at any point if you just want to continue archiving where you left off, without adding any new links ./archive # at any point if you just want to continue archiving where you left off, without adding any new links
``` ```
**3. Done!** ---
**Done!**
You can open `output/index.html` to view your archive. (favicons will appear next to each title once it has finished downloading) You can open `output/index.html` to view your archive. (favicons will appear next to each title once it has finished downloading)
If you want to host your archive somewhere to share it with other people, see the [Publishing Your Archive](#publishing-your-archive) section below. If you want to host your archive somewhere to share it with other people, see the [Publishing Your Archive](#publishing-your-archive) section below.
**4. (Optional) Schedule it to run every day** **Next Steps: Schedule it to run every day (Optional)**
You can import links from any local file path or feed url by changing the second argument to `archive.py`. You can import links from any local file path or feed url by changing the second argument to `archive.py`.
ArchiveBox will ignore links that are imported multiple times, it will keep the earliest version that it's seen. ArchiveBox will ignore links that are imported multiple times, it will keep the earliest version that it's seen.
@@ -63,7 +69,7 @@ This example archives a pocket RSS feed and an export file every 24 hours, and s
``` ```
(Add the above lines to `/etc/crontab`) (Add the above lines to `/etc/crontab`)
**Next Steps** ---
If you have any trouble, see the [Troubleshooting](#troubleshooting) section at the bottom. If you have any trouble, see the [Troubleshooting](#troubleshooting) section at the bottom.
If you'd like to customize options, see the [Configuration](#configuration) section. If you'd like to customize options, see the [Configuration](#configuration) section.