Update README.md
This commit is contained in:
parent
5fd6fcd09e
commit
1e04fa8108
1 changed files with 11 additions and 18 deletions
29
README.md
29
README.md
|
@ -49,18 +49,6 @@ brew install archivebox/archivebox/archivebox
|
|||
|
||||
# or for the Python version only, without wget/git/chrome/etc. included
|
||||
pip3 install archivebox
|
||||
```
|
||||
|
||||
Check that everything installed correctly with:
|
||||
```bash
|
||||
archivebox --version
|
||||
```
|
||||
|
||||
**To start using archivebox, you have to create a data folder and `cd` into it:**
|
||||
|
||||
```bash
|
||||
mkdir ~/archivebox && cd ~/archivebox # you can put the collection dir anywhere
|
||||
archivebox init
|
||||
|
||||
# If you're using an apt/brew/pip install you can run archivebox commands normally
|
||||
# archivebox [subcommand] [...args]
|
||||
|
@ -70,22 +58,27 @@ archivebox init
|
|||
# docker-compose run archivebox [subcommand] [...args]
|
||||
```
|
||||
|
||||
<small>Check that everything installed correctly with `archivebox --version`</small>
|
||||
|
||||
**To start using archivebox, you have to create a data folder and `cd` into it:**
|
||||
|
||||
```bash
|
||||
mkdir ~/archivebox && cd ~/archivebox # you can put the collection dir anywhere
|
||||
archivebox init
|
||||
```
|
||||
|
||||
**Then Add some URLs to your archive collection:**
|
||||
```bash
|
||||
archivebox add https://github.com/ArchiveBox/ArchiveBox
|
||||
archivebox/archivebox add --depth=1 https://example.com
|
||||
```
|
||||
|
||||
View the snapshots of the URLs you added via the self-hosted web UI:
|
||||
**View the snapshots of the URLs you added via the self-hosted web UI:**
|
||||
```bash
|
||||
archivebox manage createsuperuser # create an admin acct
|
||||
archivebox server 0.0.0.0:8000 # start the web server
|
||||
open http://127.0.0.1:8000/ # open the interactive admin panel
|
||||
```
|
||||
|
||||
Or just browse the snapshots statically on disk:
|
||||
```bash
|
||||
ls ~/archivebox/archive/*/index.html
|
||||
ls ~/archivebox/archive/*/index.html # or browse the snapshots on disk
|
||||
```
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue