From 798e00a3a8f6a1633ca64cb0de530c5785dc2ccd Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Mon, 23 Nov 2020 02:20:22 -0500 Subject: [PATCH] update docker org urls in docs --- Changelog.md | 2 +- Docker.md | 24 ++++++++++++------------ Quickstart.md | 6 +++--- Usage.md | 2 +- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/Changelog.md b/Changelog.md index dd40487..f13f9cd 100644 --- a/Changelog.md +++ b/Changelog.md @@ -17,7 +17,7 @@ See the [releases](https://github.com/ArchiveBox/ArchiveBox/releases) page for v - v0.4.9 released - `pip install archivebox` https://pypi.org/project/archivebox/ - - `docker run nikisweeting/archivebox` https://hub.docker.com/r/nikisweeting/archivebox + - `docker run archivebox/archivebox` https://hub.docker.com/r/archivebox/archivebox - https://archivebox.readthedocs.io/en/latest/ - https://github.com/ArchiveBox/ArchiveBox/releases - easy migration from previous versions diff --git a/Docker.md b/Docker.md index 566ce0e..cb2d82f 100644 --- a/Docker.md +++ b/Docker.md @@ -21,14 +21,14 @@ Make sure you have Docker installed and set up on your machine before following - [Configuration](#configuration-1) **Official Docker Hub image:** -https://hub.docker.com/r/nikisweeting/archivebox +https://hub.docker.com/r/archivebox/archivebox **Usage:** ```bash -docker run -v $PWD:/data nikisweeting/archivebox init -docker run -v $PWD:/data nikisweeting/archivebox add 'https://example.com' -docker run -v $PWD:/data -it nikisweeting/archivebox manage createsuperuser -docker run -v $PWD:/data -p 8000:8000 nikisweeting/archivebox server 0.0.0.0:8000 +docker run -v $PWD:/data archivebox/archivebox init +docker run -v $PWD:/data archivebox/archivebox add 'https://example.com' +docker run -v $PWD:/data -it archivebox/archivebox manage createsuperuser +docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox server 0.0.0.0:8000 ``` --- @@ -129,7 +129,7 @@ If you want to access your archive server with HTTPS, put a reverse proxy like N Fetch and run the ArchiveBox Docker image to create your initial archive. ```bash -echo 'https://example.com' | docker run -it -v $PWD:/data nikisweeting/archivebox add +echo 'https://example.com' | docker run -it -v $PWD:/data archivebox/archivebox add ``` Replace `~/ArchiveBox` in the command above with the full path to a folder to use to store your archive on the host, or name of a Docker data volume. @@ -141,15 +141,15 @@ Make sure the data folder you use host is either a new, uncreated path, or if it **To add a single URL to the archive** or a list of links from a file, pipe them in via stdin. This will archive each link passed in. ```bash -echo 'https://example.com' | docker run -it -v $PWD:/data nikisweeting/archivebox add +echo 'https://example.com' | docker run -it -v $PWD:/data archivebox/archivebox add # or -docker run -it -v $PWD:/data nikisweeting/archivebox add < bookmarks.html +docker run -it -v $PWD:/data archivebox/archivebox add < bookmarks.html ``` **To add a list of pages via feed URL or remote file,** pass the URL of the feed as an argument. ```bash -docker run -it -v $PWD:/data nikisweeting/archivebox add 'https://example.com/some/rss/feed.xml' +docker run -it -v $PWD:/data archivebox/archivebox add 'https://example.com/some/rss/feed.xml' ``` The `depth` argument controls if you want to save the links contained in that URL, or only the specified URL. @@ -199,7 +199,7 @@ The next easiest way to get/set config is using the archivebox CLI: docker-compose run archivebox config --get RESOLUTION docker-compose run archivebox config --set RESOLUTION=1440,900 # or -docker run -it -v $PWD:/data nikisweeting/archivebox config --set MEDIA_TIMEOUT=120 +docker run -it -v $PWD:/data archivebox/archivebox config --set MEDIA_TIMEOUT=120 ``` ArchiveBox in Docker accepts all the same environment variables as normal, see the list on the [[Configuration]] page. @@ -207,10 +207,10 @@ ArchiveBox in Docker accepts all the same environment variables as normal, see t To set environment variables for a single run, you can use the `env KEY=VAL ...` command, `-e KEY=VAL`, or `--env-file=somefile.env`. ```bash -echo 'https://example.com' | docker run -it -v $PWD:/data -e FETCH_SCREENSHOT=False nikisweeting/archivebox add +echo 'https://example.com' | docker run -it -v $PWD:/data -e FETCH_SCREENSHOT=False archivebox/archivebox add ``` ```bash -docker run -i -v --env-file=ArchiveBox.env nikisweeting/archivebox +docker run -i -v --env-file=ArchiveBox.env archivebox/archivebox ``` You can also edit the `data/ArchiveBox.conf` file directly and the changes will take effect on the next run. diff --git a/Quickstart.md b/Quickstart.md index 46554fc..d3fab47 100644 --- a/Quickstart.md +++ b/Quickstart.md @@ -23,7 +23,7 @@ We recommend using Docker because it has all the extractors and dependencies wor # first make sure you have docker: https://docs.docker.com/get-docker/ # then run this to get started with a collection in the current directory -docker run -v $PWD:/data -it nikisweeting/archivebox init +docker run -v $PWD:/data -it archivebox/archivebox init # alternatively, install ArchiveBox and its dependencies directly on your system without docker # (script prompts for user confirmation before installing anything) @@ -65,7 +65,7 @@ Follow the links here to find instructions for exporting a list of URLs from eac Pass in URLs directly, import a list of links from a file, or import from a feed URL. All via stdin: ```bash # if using docker -docker run -v $PWD:/data -it nikisweeting/archivebox add 'https://example.com' +docker run -v $PWD:/data -it archivebox/archivebox add 'https://example.com' # or if not using docker archivebox add 'https://example.com' @@ -81,7 +81,7 @@ Open `./index.html` to view your archive. (favicons will appear next to each ti You can also use the interactive Web UI to view/manage/add links to your archive: ```bash # with docker: -docker run -v $PWD:/data -it -p 8000:8000 nikisweeting/archivebox +docker run -v $PWD:/data -it -p 8000:8000 archivebox/archivebox # or without docker: archivebox server diff --git a/Usage.md b/Usage.md index 4883763..2f9af07 100644 --- a/Usage.md +++ b/Usage.md @@ -29,7 +29,7 @@ All three of these ways of running ArchiveBox are equivalent and interchangeable - `archivebox [subcommand] [...args]` *Using the PyPI package via `pip install archivebox`* -- `archivebox run -it -v $PWD:/data nikisweeting/archivebox [subcommand] [...args]` +- `archivebox run -it -v $PWD:/data archivebox/archivebox [subcommand] [...args]` *Using the official Docker image* - `docker-compose run archivebox [subcommand] [...args]` *Using the official Docker image w/ Docker Compose*