Merging Collections

Two or more existing ArchiveBox collection dirs can be merged together by simply combining the contents of archive/* and re-running archivebox init to pull the new Snapshots into the index.

Warning

Snapshot folders are identified by their timestamp (in milliseconds), this is normally not a problem for archives collected on one machine, but when merging archives from two different instances that ran at the same time it means there is a small chance of conflicts. Check the contents of archive/ before merging, and backup any directories that may conflict before proceeding.

Run archivebox init and archivebox status in each existing collection to apply migrations and confirm that both collections use the current ArchiveBox version. The complete example below creates two temporary collections so the merge can be reproduced safely; replace those paths with your existing collection paths.

set -euo pipefail
merge_root="$(mktemp -d)"
trap 'rm -rf "$merge_root"' EXIT
collection_one="$merge_root/archivebox1"
collection_two="$merge_root/archivebox2"
merged_collection="$merge_root/archivebox_new"

mkdir -p "$collection_one" "$collection_two"
cd "$collection_one"
archivebox init
archivebox add --plugins=wget "${ARCHIVEBOX_DOCS_URL_ONE:-https://example.com/?collection=one}"
archivebox status

cd "$collection_two"
archivebox init
archivebox add --plugins=wget "${ARCHIVEBOX_DOCS_URL_TWO:-https://example.com/?collection=two}"
archivebox status

Create a new empty archivebox collection in a new folder somewhere, this will hold the new merged collection

mkdir -p "$merged_collection"
cd "$merged_collection"
archivebox init

Copy everything under ./archive/* in each old collection into the new collection's ./archive/ folder

rsync --archive "$collection_one/archive/" "$merged_collection/archive/"
rsync --archive "$collection_two/archive/" "$merged_collection/archive/"

Run archivebox update in the new merged collection to import the copied Snapshot directories and regenerate the index

cd "$merged_collection"
archivebox update --index-only

The new collection should now contain all the entries from the old collections combined

cd "$merged_collection"
archivebox status

test "$(find archive/users/system/snapshots -name index.jsonl | wc -l | tr -d ' ')" -eq 2

For more information about why Snapshot index files are usually updated lazily, see: https://github.com/ArchiveBox/ArchiveBox/issues/962

After you've confirmed your Snapshots are present in the new index, the old index.sqlite3, index.json, index.html, etc. main index files from the old archives can be safely deleted. You can optionally merge the contents of ArchiveBox.conf (your ArchiveBox config options), sources/ (copies of all URLs imported in their original format), logs/ (ArchiveBox error logs and debug info), and other root-level items yourself if that data is important to you.

Modify the ArchiveBox SQLite3 DB directly

If you need to automate changes to the ArchiveBox DB (for example adding a User from an Ansible script), you can modify the SQLite3 DB directly.

Note, this is often unnecessary for modifying ArchiveBox on a host that doesn't have the CLI installed, as you can also copy the index.sqlite3 to a local machine that has it, do the modifications locally, then copy the modified db back into place on the host. (Docker/CLI/GUI/Web ArchiveBox all share the same DB schema/format)

set -euo pipefail
collection="$(mktemp -d)"
trap 'rm -rf "$collection"' EXIT
cd "$collection"
archivebox init
sqlite3 index.sqlite3 'SELECT COUNT(*) FROM core_snapshot;'

Example: Modifying an existing user's email

UPDATE auth_user
SET email = 'someNewEmail@example.com', is_superuser = 1
WHERE username = 'someUsernameHere';

Example: Adding a new user with a hashed password

Note: this is just an example to demonstrate direct database usage. If you are trying to create a user on initial setup, use the ADMIN_USERNAME & ADMIN_PASSWORD configuration options.

First, generate the hashed password in a Python shell using Django's make_password function.

This can be done on any machine with Python 3+, it doesn't have to have ArchiveBox installed.

uv run python -c "from django.contrib.auth.hashers import PBKDF2PasswordHasher; print(PBKDF2PasswordHasher().encode('somePasswordHere', 'someSaltHere'))"

from django.contrib.auth.hashers import PBKDF2PasswordHasher

hasher = PBKDF2PasswordHasher()
password_hash = hasher.encode("somePasswordHere", "someSaltHere")
assert hasher.verify("somePasswordHere", password_hash)

Use the generated hashed password to insert a new User row in the SQLite3 database directly:

set -euo pipefail
collection="$(mktemp -d)"
trap 'rm -rf "$collection"' EXIT
cd "$collection"
archivebox init
password_hash="$(uv run python -c "from django.contrib.auth.hashers import PBKDF2PasswordHasher; print(PBKDF2PasswordHasher().encode('somePasswordHere', 'someSaltHere'))")"
sqlite3 index.sqlite3 "INSERT INTO auth_user (password, last_login, is_superuser, username, first_name, last_name, email, is_staff, is_active, date_joined) VALUES ('$password_hash', NULL, 0, 'someUsername', '', '', 'someEmail@example.com', 0, 1, CURRENT_TIMESTAMP);"
test "$(sqlite3 index.sqlite3 "SELECT COUNT(*) FROM auth_user WHERE username='someUsername';")" -eq 1

INSERT INTO "auth_user" ("password", "last_login", "is_superuser", "username", "first_name", "last_name", "email", "is_staff", "is_active", "date_joined")
VALUES ('pbkdf2_sha256$216000$someSaltHere$+2beZufc3JUXnmn0tG+2peJEBh7MjxPYmT3YfIFzEl0=', NULL, 0, 'someUsername', '', '', 'someEmail@example.com', 0, 1, '2022-03-22 23:34:02.333042')

Replace the values above with the desired username, email, and password hash from python output^.

Log in using the new generated user to confirm it works https://localhost:8000/admin/login/ user: someUsername pass:somePasswordHere

More info:

Database Troubleshooting

See here Troubleshooting: Database...

6.9 KiB Raw Blame History

Merging Collections

Modify the ArchiveBox SQLite3 DB directly

Example: Modifying an existing user's email

Example: Adding a new user with a hashed password

Database Troubleshooting

Related Documents

6.9 KiB

Raw Blame History