The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-12 19:50:57 +05:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Tighten native first-run instructions

Browse Source
This commit is contained in:
Nick Sweeting 2026-08-01 01:16:43 -07:00
parent d391fc8044
commit e90e70fe39
No known key found for this signature in database
7 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -271,8 +271,9 @@ archivebox init # instantialize a new collection
archivebox install # install all the runtime dependencies (e.g. chrome, single-file, yt-dlp, etc.)
</code></pre>
</li>
<li>Optional: Start the server then login to the Web UI <a href="http://archivebox.localhost:8000">http://archivebox.localhost:8000</a> ⇢ Admin.
<pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000
<li>Create an admin account, then optionally start the server and log in to the Web UI at <a href="http://archivebox.localhost:8000">http://archivebox.localhost:8000</a> ⇢ Admin.
<pre lang="bash"><code style="white-space: pre-line">archivebox manage createsuperuser
archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--help]
archivebox help
@ -307,8 +308,9 @@ archivebox add 'https://example.com'
</code></pre>
<br/>
</li>
<li>Optional: Start the server then login to the Web UI <a href="http://archivebox.localhost:8000">http://archivebox.localhost:8000</a> ⇢ Admin.
<pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000
<li>Create an admin account, then optionally start the server and log in to the Web UI at <a href="http://archivebox.localhost:8000">http://archivebox.localhost:8000</a> ⇢ Admin.
<pre lang="bash"><code style="white-space: pre-line">archivebox manage createsuperuser
archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--help]
archivebox help
@ -339,8 +341,9 @@ archivebox init
archivebox install
</code></pre>
</li>
<li>Optional: Start the server then login to the Web UI <a href="http://archivebox.localhost:8000">http://archivebox.localhost:8000</a> ⇢ Admin.
<pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000
<li>Create an admin account, then optionally start the server and log in to the Web UI at <a href="http://archivebox.localhost:8000">http://archivebox.localhost:8000</a> ⇢ Admin.
<pre lang="bash"><code style="white-space: pre-line">archivebox manage createsuperuser
archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--help]
archivebox help

2
docs/Docker.md
View File

@ -68,7 +68,7 @@ docker compose run archivebox init
docker compose run archivebox manage createsuperuser
```
To use [Sonic](https://github.com/valeriansaliou/sonic) for improved full-text search, select it as the search backend. ArchiveBox installs and starts the managed service automatically:
ArchiveBox installs and enables both ripgrep and [Sonic](https://github.com/valeriansaliou/sonic). To make Sonic the default engine selected in the UI while keeping both backends available:
```bash
docker compose run archivebox config --set SEARCH_BACKEND_ENGINE=sonic
docker compose run archivebox update --index-only

6
docs/Install.md
View File

@ -126,7 +126,6 @@ Make sure you have [Homebrew](https://brew.sh/) installed first.
```bash
brew install uv
uv tool install --python 3.13 --upgrade 'git+https://github.com/ArchiveBox/ArchiveBox.git@dev'
archivebox install
```
<img src="https://assets.ubuntu.com/v1/c5cb0f8e-picto-ubuntu.svg" width="30px" align="right"/>
@ -236,8 +235,7 @@ archivebox help
```
(ensure the version shown is the most recent available from [Releases](https://github.com/ArchiveBox/ArchiveBox/releases))
Make sure to run `archivebox` **as an unprivileged user** (i.e. without `sudo` / not logged in as `root`).
Make sure to run all commands, including `archivebox version`, `archivebox help`, etc. **inside a data directory** (or a new empty dir that will become a data dir).
ArchiveBox can be launched as `root` by setup and package-manager flows; it creates or selects the `archivebox` service account and drops privileges before writing collection data. Run collection commands such as `init`, `install`, `add`, and `status` inside the data directory. Informational commands such as `version` and `help` can run anywhere.
If you have issues getting Chromium / Google Chrome or other dependencies working with ArchiveBox, see the [[Chromium Install]] and [[Troubleshooting]] pages for more detailed instructions.
@ -264,7 +262,7 @@ archivebox status
```bash
# OR start the webserver and view them in the Web UI
archivebox server 0.0.0.0:8000
open http://web.archivebox.localhost:8000
# Visit http://web.archivebox.localhost:8000 in a browser
```
See our [[Usage]] Wiki documentation page for more examples.

2
docs/Quickstart.md
View File

@ -71,7 +71,7 @@ docker compose up -d
# or without Docker:
archivebox server
open http://web.archivebox.localhost:8000
# Visit http://web.archivebox.localhost:8000 in a browser
```
---

2
docs/Setting-up-Authentication.md
View File

@ -40,7 +40,7 @@ archivebox manage createsuperuser
archivebox manage changepassword <username>
# equivalent: docker compose run archivebox manage [...]
# equivalent: docker run -v $PWD:/data archivebox/archivebox manage [...]
# equivalent: docker run -v $PWD:/data archivebox/archivebox:dev manage [...]
```
> [!TIP]

2
docs/Usage.md
View File

@ -26,7 +26,7 @@
All three of these ways of running ArchiveBox are equivalent and interchangeable:
- `archivebox [subcommand] [...args]`
*Using the Python package via `uv tool install archivebox`*
*Using the Python package via the current `uv` instructions in [[Install]]*
- `docker run ... archivebox/archivebox [subcommand] [...args]`
*Using the official Docker image*
- `docker compose run archivebox [subcommand] [...args]`

26
docs/codeblocks.toml
View File

@ -14,13 +14,13 @@ version = 2
"16f90085b2eb8756-1" = "illustration"
"811eaaada5eb1861-1" = "run"
"8e6f975ced292777-1" = "run"
"588be84a1f0fda9a-1" = "illustration"
"4da22c86e09ce7d4-1" = "illustration"
"a7a123ba522227be-1" = "run"
"fcdd073a5440f5ca-1" = "run"
"588be84a1f0fda9a-2" = "illustration"
"4da22c86e09ce7d4-2" = "illustration"
"05be9e44a8ae9875-1" = "run"
"2b08779e4d24d305-1" = "run"
"588be84a1f0fda9a-3" = "illustration"
"4da22c86e09ce7d4-3" = "illustration"
"c6e77a7ea47549e5-1" = "illustration"
"6392c7b5f3593d07-1" = "run"
"5d43b3d527ac69c6-1" = "run"
@ -128,7 +128,7 @@ version = 2
# docs/Install.md
"662be0691524555c-1" = "illustration"
"fb630418e789bca8-1" = "run"
"5f7f9732e0ae5a62-1" = "run"
"73f9f36a369f2398-1" = "run"
"39d6e53c2e53ef77-1" = "run"
"6a149b1a387f76cc-1" = "run"
@ -138,7 +138,7 @@ version = 2
"035ecb710f7fc2a8-1" = "illustration"
"e4e22c56cb720344-1" = "illustration"
"2905d7f9dece0b61-1" = "run"
"e1c3e8b9016a71a9-1" = "illustration"
"a64c69417bb98a93-1" = "illustration"
"0dc947d99d081ca3-1" = "run"
# docs/Merging-Collections.md
@ -161,7 +161,7 @@ version = 2
# docs/Quickstart.md
"9900ea0b79f00814-1" = "illustration"
"4972b2ae112247f0-1" = "illustration"
"40cbdd365d234433-1" = "illustration"
"c84835e713d1c625-1" = "run"
# docs/Scheduled-Archiving.md
@ -197,7 +197,7 @@ version = 2
"74e75b4a84bbb636-1" = "run"
# docs/Setting-up-Authentication.md
"c2de5f67fd56b58c-1" = "illustration"
"38914ce4a10f4d3f-1" = "illustration"
"9821835f15ad67b2-1" = "illustration"
"83c90c1a23a33f90-2" = "run"
"7caaf25736e20132-1" = "illustration"
@ -250,12 +250,12 @@ version = 2
"85f531841ec3e169-1" = "run"
[scenarios]
"5f7f9732e0ae5a62-1" = "system"
"976dcb4e461d60bb-1" = "docker"
"fcdd073a5440f5ca-1" = "system"
"73f9f36a369f2398-1" = "system"
"811eaaada5eb1861-1" = "system"
"8e6f975ced292777-1" = "collection"
"a7a123ba522227be-1" = "system"
"fcdd073a5440f5ca-1" = "system"
"05be9e44a8ae9875-1" = "system"
"2b08779e4d24d305-1" = "system"
"6392c7b5f3593d07-1" = "collection"
@ -293,7 +293,7 @@ version = 2
"b0032c4cfcac6915-1" = "docker"
"c46afe2bbd31a239-1" = "docker"
"4c9a12d2d0a26431-1" = "docker"
"fb630418e789bca8-1" = "system"
"73f9f36a369f2398-1" = "system"
"39d6e53c2e53ef77-1" = "system"
"6a149b1a387f76cc-1" = "system"
"73e5b1670430202c-1" = "system"
@ -331,12 +331,12 @@ version = 2
"85f531841ec3e169-1" = "collection"
[environments]
"5f7f9732e0ae5a62-1" = "macos"
"976dcb4e461d60bb-1" = "docker"
"fcdd073a5440f5ca-1" = "root"
"73f9f36a369f2398-1" = "root"
"811eaaada5eb1861-1" = "ubuntu"
"8e6f975ced292777-1" = "ubuntu"
"a7a123ba522227be-1" = "root"
"fcdd073a5440f5ca-1" = "root"
"05be9e44a8ae9875-1" = "macos"
"2b08779e4d24d305-1" = "macos"
"6392c7b5f3593d07-1" = "ubuntu"
@ -374,7 +374,7 @@ version = 2
"b0032c4cfcac6915-1" = "docker"
"c46afe2bbd31a239-1" = "docker"
"4c9a12d2d0a26431-1" = "docker"
"fb630418e789bca8-1" = "macos"
"73f9f36a369f2398-1" = "root"
"39d6e53c2e53ef77-1" = "freebsd"
"6a149b1a387f76cc-1" = "openbsd"
"73e5b1670430202c-1" = "ubuntu"