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

Use the reached host for browser setup

Browse Source
This commit is contained in:
Nick Sweeting 2026-08-19 03:08:13 -07:00
parent 771f3c6496
commit 120abe41df
No known key found for this signature in database
6 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -189,7 +189,7 @@ docker compose pull
<li>Start the server, which initializes a new collection automatically.
<pre lang="bash"><code style="white-space: pre-line">docker compose up -d --wait
</code></pre></li>
<li>Open <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a> to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the web setup wizard.
<li>Open <code>/admin/</code> on the hostname or IP used to reach ArchiveBox (local example: <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a>) to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the web setup wizard.
<pre lang="bash"><code style="white-space: pre-line">
# run CLI commands inside the server container started above
docker compose exec archivebox archivebox add 'https://example.com'
@ -214,7 +214,7 @@ docker run --rm -v $PWD:/data -it archivebox/archivebox:dev init
docker run --rm -v $PWD:/data -it archivebox/archivebox:dev install
</code></pre>
</li>
<li>Optional: Start the server, then open <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a> to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the web setup wizard.
<li>Optional: Start the server, then open <code>/admin/</code> on the hostname or IP used to reach ArchiveBox (local example: <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a>) to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the web setup wizard.
<pre lang="bash"><code style="white-space: pre-line">docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox:dev
# completely optional, CLI can always be used without running a server
# docker run -v $PWD:/data -it archivebox/archivebox:dev [subcommand] [--help]
@ -270,7 +270,7 @@ archivebox init # initialize a new collection
archivebox install # install all the runtime dependencies (e.g. chrome, single-file, yt-dlp, etc.)
</code></pre>
</li>
<li>Optionally start the server, then open <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a> to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the same web setup wizard used by Docker installs.
<li>Optionally start the server, then open <code>/admin/</code> on the hostname or IP used to reach ArchiveBox (local example: <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a>) to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the same web setup wizard used by Docker installs.
<pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--help]
@ -306,7 +306,7 @@ archivebox add 'https://example.com'
</code></pre>
<br/>
</li>
<li>Optionally start the server, then open <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a> to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the same web setup wizard used by Docker installs.
<li>Optionally start the server, then open <code>/admin/</code> on the hostname or IP used to reach ArchiveBox (local example: <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a>) to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the same web setup wizard used by Docker installs.
<pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--help]
@ -339,7 +339,7 @@ archivebox init
archivebox install
</code></pre>
</li>
<li>Optionally start the server, then open <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a> to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the same web setup wizard used by Docker installs.
<li>Optionally start the server, then open <code>/admin/</code> on the hostname or IP used to reach ArchiveBox (local example: <a href="http://admin.archivebox.localhost:8000/admin/">http://admin.archivebox.localhost:8000/admin/</a>) to create the first admin. If <code>BASE_URL</code> is not configured yet, continue through the same web setup wizard used by Docker installs.
<pre lang="bash"><code style="white-space: pre-line">archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--help]

2
archivebox/tests/test_server_security_browser.py
View File

@ -743,7 +743,7 @@ def test_unconfigured_public_host_superuser_can_reach_setup_wizard(tmp_path: Pat
compose_text = (Path(__file__).resolve().parents[2] / "docker-compose.yml").read_text()
compose = yaml.safe_load(compose_text)
archivebox_environment = compose["services"]["archivebox"]["environment"]
assert "Open http://admin.archivebox.localhost:8000/admin/ to create the first admin and finish web setup." in compose_text
assert "Open /admin/ on the hostname or IP used to reach ArchiveBox" in compose_text
assert "manage createsuperuser" not in compose_text
assert compose["services"]["archivebox"]["restart"] == "unless-stopped"
assert "BASE_URL" in archivebox_environment

2
docker-compose.yml
View File

@ -3,7 +3,7 @@
# curl -fsSL 'https://docker-compose.archivebox.io' > docker-compose.yml
# docker compose pull
# docker compose up -d --wait
# Open http://admin.archivebox.localhost:8000/admin/ to create the first admin and finish web setup.
# Open /admin/ on the hostname or IP used to reach ArchiveBox (local: http://admin.archivebox.localhost:8000/admin/).
# docker compose exec archivebox archivebox add --depth=1 'https://news.ycombinator.com'
# docker compose exec -T archivebox archivebox add < ~/Downloads/bookmarks.txt

2
docs/Docker.md
View File

@ -202,7 +202,7 @@ docker run --rm -it -v "$PWD:/data" archivebox/archivebox:dev init
docker run -d --name archivebox -v "$PWD:/data" -p 8000:8000 archivebox/archivebox:dev
```
Then open <http://admin.archivebox.localhost:8000/admin/> to create the first admin. If `BASE_URL` is not configured yet, continue through the web setup wizard.
Then open `/admin/` on the hostname or IP used to reach ArchiveBox (local example: <http://admin.archivebox.localhost:8000/admin/>) to create the first admin. If `BASE_URL` is not configured yet, continue through the web setup wizard.
*(You can create a collection in any directory you want, `~/archivebox/data` is just used as an example here)*

3
docs/Quickstart.md
View File

@ -71,7 +71,8 @@ docker compose up -d
# or without Docker:
archivebox server
# Visit http://admin.archivebox.localhost:8000/admin/ to create the first admin.
# Open /admin/ on the hostname or IP used to reach ArchiveBox.
# Local example: http://admin.archivebox.localhost:8000/admin/
# If BASE_URL is not configured yet, continue through the web setup wizard.
```

2
docs/codeblocks.toml
View File

@ -163,7 +163,7 @@ version = 2
# docs/Quickstart.md
"d81b70ce03456db1-1" = "illustration"
"f3fd34dae6f6f6ab-1" = "illustration"
"16a101113c74c070-1" = "illustration"
"c84835e713d1c625-1" = "run"
# docs/Scheduled-Archiving.md