mirrors/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2025-05-31 14:58:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update README.md

Browse source
This commit is contained in:
Nick Sweeting 2024-01-28 04:05:57 -08:00 • committed by GitHub
parent 225ec2dc32
commit a54655512a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -520,7 +520,7 @@ ls ./archive/*/index.html # or inspect snapshot data directly on the filesystem
<br/> <br/>
<details open> <details>
<summary><b>🖥&nbsp; Web UI Usage</b></summary> <summary><b>🖥&nbsp; Web UI Usage</b></summary>
<pre lang="bash"><code style="white-space: pre-line"> <pre lang="bash"><code style="white-space: pre-line">
# Start the server on bare metal (pip/apt/brew/etc): # Start the server on bare metal (pip/apt/brew/etc):
@ -678,20 +678,21 @@ It uses all available methods out-of-the-box, but you can disable extractors and
<img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/ea672e6b-4df5-49d8-b550-7f450951fd27" width="330px" align="right" style="float: right"/> <img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/ea672e6b-4df5-49d8-b550-7f450951fd27" width="330px" align="right" style="float: right"/>
ArchiveBox can be configured via environment variables, by using the `archivebox config` CLI, or by editing `./ArchiveBox.conf` directly. ArchiveBox can be configured via environment variables, by using the `archivebox config` CLI, or by editing `./ArchiveBox.conf` directly.
<br/>
```bash <details>
archivebox config # view the entire config <summary><i>Expand to see examples...</i></summary>
<pre lang="bash"><code style="white-space: pre-line">archivebox config # view the entire config
archivebox config --get CHROME_BINARY # view a specific value archivebox config --get CHROME_BINARY # view a specific value
<br/>
archivebox config --set CHROME_BINARY=chromium # persist a config using CLI archivebox config --set CHROME_BINARY=chromium # persist a config using CLI
# OR # OR
echo CHROME_BINARY=chromium >> ArchiveBox.conf # persist a config using file echo CHROME_BINARY=chromium >> ArchiveBox.conf # persist a config using file
# OR # OR
env CHROME_BINARY=chromium archivebox ... # run with a one-off config env CHROME_BINARY=chromium archivebox ... # run with a one-off config
``` </code></pre>
<sub>These methods also work the same way when run inside Docker, see the <a href="https://github.com/ArchiveBox/ArchiveBox/wiki/Docker#configuration">Docker Configuration</a> wiki page for details.</sub>
<sup>These methods also work the same way when run inside Docker, see the <a href="https://github.com/ArchiveBox/ArchiveBox/wiki/Docker#configuration">Docker Configuration</a> wiki page for details.</sup> </details>
<br/>
The configuration is documented here: **[Configuration Wiki](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration)**, and loaded here: [`archivebox/config.py`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/config.py). The configuration is documented here: **[Configuration Wiki](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration)**, and loaded here: [`archivebox/config.py`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/config.py).
<a name="most-common-options-to-tweak"></a> <a name="most-common-options-to-tweak"></a>