From 64ddab3750b7d425553b9db1f7d9967bc545d0ba Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Thu, 4 Jan 2024 12:44:27 -0800 Subject: [PATCH] add more data to archive layout section --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3b0a89cb..35d78404 100644 --- a/README.md +++ b/README.md @@ -579,6 +579,7 @@ To achieve high-fidelity archives in as many situations as possible, ArchiveBox
Expand to learn more about ArchiveBox's dependencies... +
For better security, easier updating, and to avoid polluting your host system with extra dependencies, **it is strongly recommended to use the official [Docker image](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker)** with everything pre-installed for the best experience. @@ -617,19 +618,27 @@ For detailed information about upgrading ArchiveBox and its dependencies, see: h ## Archive Layout -All of ArchiveBox's state (including the index, snapshot data, and config file) is stored in a single folder called the "ArchiveBox data folder". All `archivebox` CLI commands must be run from inside this folder, and you first create it by running `archivebox init`. +All of ArchiveBox's state (including the SQLite DB, archived assets, config, logs, etc.) is stored in a single folder called the "ArchiveBox Data Folder". Data folders can be created anywhere (`~/archivebox` or `$PWD/data` as seen in our examples), and you can create more than one for different collections.
Expand to learn more about the layout of Archivebox's data on-disk... +
-The on-disk layout is optimized to be easy to browse by hand and durable long-term. The main index is a standard `index.sqlite3` database in the root of the data folder (it can also be exported as static JSON/HTML), and the archive snapshots are organized by date-added timestamp in the `./archive/` subfolder. +All `archivebox` CLI commands are designed to be run from inside an ArchiveBox data folder, starting with `archivebox init` to initialize a new collection inside an empty directory. + +```bash +mkdir ~/archivebox && cd ~/archivebox +archivebox init +``` + +The on-disk layout is optimized to be easy to browse by hand and durable long-term. The main index is a standard `index.sqlite3` database in the root of the data folder (it can also be [exported as static JSON/HTML](https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive#2-export-and-host-it-as-static-html)), and the archive snapshots are organized by date-added timestamp in the `./archive/` subfolder. ```bash -./ +/data/ index.sqlite3 ArchiveBox.conf archive/ @@ -657,6 +666,7 @@ You can export the main index to browse it statically as plain HTML files in a f
Expand to learn how to export your ArchiveBox collection... +
> **Note** > These exports are not paginated, exporting many URLs or the entire archive at once may be slow. Use the filtering CLI flags on the `archivebox list` command to export specific Snapshots or ranges. @@ -673,6 +683,8 @@ archivebox list --csv=timestamp,url,title > index.csv # export to csv spreadshe The paths in the static exports are relative, make sure to keep them next to your `./archive` folder when backing them up or viewing them. +**Learn More Here:** [Publishing Your Archive: Export & Host as Static HTML](https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive#2-export-and-host-it-as-static-html) +