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、Fork 或宣傳語當成品質證明。README 在「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 將運作方式分散在「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.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 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 的「README」段落提到:Without active preservation effort, everything on the internet eventually disappears or degrades.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:🎬 YouTube/SoundCloud/etc. ➡️ MP3/MP4s, subtitles, metadata, thumbnail, ...。