From 17485c922f14bd7bd848e8679d0eee1ec823a455 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Thu, 8 Apr 2021 06:57:58 -0400 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5de87204..dca6e8b4 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,10 @@ At the end of the day, the goal is to sleep soundly knowing that the part of the

bookshelf graphic   logo   bookshelf graphic

+Demo | Screenshots | Usage +
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . +

@@ -77,13 +81,7 @@ At the end of the day, the goal is to sleep soundly knowing that the part of the
-
-
-Demo | Screenshots | Usage -
-. . . . . . . . . . . . . . . . . . . . . . . . . . . . -

cli init screenshot cli init screenshot server snapshot admin screenshot @@ -108,6 +106,8 @@ No matter which install method you choose, they all roughly follow this 3-step p
  • View the archive: archivebox server or archivebox list ..., ls ./archive/*/index.html
  • +#### ⚡️  Install + *(click to expand your preferred **► `distribution`** below for full setup instructions)*
    @@ -275,6 +275,8 @@ archivebox help # to see more options
    +
    + #### ⚡️  CLI Usage ```bash @@ -289,6 +291,20 @@ archivebox help - `archivebox oneshot` archive single URLs without starting a whole collection - `archivebox shell/manage dbshell` open a REPL to use the [Python API](https://docs.archivebox.io/en/latest/modules.html) (alpha), or SQL API +#### ⚡️  Web UI Usage + +```bash +archivebox server 0.0.0.0:8000 +``` +Then open http://127.0.0.1:8000 to view the UI. + +```bash +# optionally lock down the Web UI to require logging in with an admin account +archivebox manage createsuperuser +archivebox config --set PUBLIC_INDEX=False +archivebox config --set PUBLIC_SNAPSHOTS=False +archivebox config --set PUBLIC_ADD_VIEW=False +```
    @@ -305,7 +321,7 @@ archivebox help
    - +
    --- @@ -354,6 +370,8 @@ See the [Usage: CLI](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#CLI-Usa It also includes a built-in scheduled import feature with `archivebox schedule` and browser bookmarklet, so you can pull in URLs from RSS feeds, websites, or the filesystem regularly/on-demand. +
    + ## Output formats All of ArchiveBox's state (including the index, snapshot data, and config file) is stored in a single folder called the "ArchiveBox data folder". All `archivebox` CLI commands must be run from inside this folder, and you first create it by running `archivebox init`. @@ -396,6 +414,8 @@ archivebox config --set YOUTUBEDL_ARGS='--max-filesize=500m' archivebox config --help ``` +
    + ---