ArchiveBox/ArchiveBox:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく ArchiveBox/ArchiveBox の導入と確認ガイドです。
プロジェクトの範囲
ArchiveBox/ArchiveBox の README はプロジェクトを「🗃 Open source self-hosted web archiving. Takes URLs/browser history/bookmarks/Pocket/Pinboard/etc., saves HTML, JS, PDFs, media, and more...」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「README」には次の説明があります。▶️ Quickstart | Demo | GitHub | Documentation | Info & Motivation | Community。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「README」にある内容から、用途が合うかを先に判断できます。🎥 Social Media/News ➡️ post content TXT, comments, title, author, images, ...。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。🌐 HTML/Any websites ➡️ original HTML+CSS+JS, singlefile HTML, screenshot PNG, PDF, WARC, title, article text, favicon, headers, ...。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「README」など複数の箇所に分かれています。確認できる情報は次の通りです。We aim to make your data immediately useful, and kept in formats that other programs can read directly. As output, we save standard HTML, PNG, PDF, TXT, JSON, WARC, SQLite, all guaranteed to be readable for decades to come.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 mkdir -p ~/archivebox/data # create a new data dir anywhere cd ~/archivebox/data # IMPORTANT: cd into the directory # archivebox [subcommand] [--help] archivebox version archivebox help # equivalent: docker compose run archivebox [subcommand] [--help] docker compose run archivebox help # equivalent: docker run -it -v $PWD:/data archivebox/archivebox:dev [subcommand] [--help] docker run -it -v $PWD:/data archivebox/archivebox:dev help # optional: import your browser cookies into a p 実行可能なコマンドがない場合は手順を作らず、「docker compose run archivebox help」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「README」にはWithout active preservation effort, everything on the internet eventually disappears or degrades.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料には🎬 YouTube/SoundCloud/etc. ➡️ MP3/MP4s, subtitles, metadata, thumbnail, ...ともあります。