From f23abba9773b67ad9f2fd04d6f2e8e056dfa6521 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Wed, 24 Apr 2024 16:37:22 -0700 Subject: [PATCH] remove references to main branch in favor of stable branch --- Docker.md | 14 +++++++------- Install.md | 6 +++--- Troubleshooting.md | 4 ++-- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Docker.md b/Docker.md index 0dab18b..2c61253 100644 --- a/Docker.md +++ b/Docker.md @@ -26,8 +26,8 @@ Running ArchiveBox with Docker allows you to manage it in a container without ex ```bash docker pull archivebox/archivebox ``` -- [`Dockerfile`](https://github.com/ArchiveBox/ArchiveBox/blob/main/Dockerfile) -- [`docker-compose.yml`](https://github.com/ArchiveBox/ArchiveBox/blob/main/docker-compose.yml) +- [`Dockerfile`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/Dockerfile) +- [`docker-compose.yml`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/docker-compose.yml) - [`archivebox-kubernetes.yml`](https://github.com/ArchiveBox/docker-archivebox/blob/master/archivebox.yml) @@ -48,7 +48,7 @@ docker pull archivebox/archivebox ### Setup -A full [`docker-compose.yml`](https://github.com/ArchiveBox/ArchiveBox/blob/main/docker-compose.yml) file is provided with all the extras included. +A full [`docker-compose.yml`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/docker-compose.yml) file is provided with all the extras included. You can uncomment sections within it to enable extra features, or run the basic version as-is. @@ -58,7 +58,7 @@ mkdir -p ~/archivebox/data && cd ~/archivebox # download the compose file into the directory curl -fsSL 'https://docker-compose.archivebox.io' > docker-compose.yml -# (shortcut for getting https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/main/docker-compose.yml) +# (shortcut for getting https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/stable/docker-compose.yml) # run setup to choose an admin username+password (or set ADMIN_USERNAME/ADMIN_PASSWORD env vars) docker compose run archivebox init --setup @@ -67,7 +67,7 @@ docker compose run archivebox init --setup To use [Sonic](https://github.com/valeriansaliou/sonic) for improved full-text search, download this config & uncomment the sonic service in `docker-compose.yml`: ```bash # download the sonic config file into your data folder (e.g. ~/archivebox) -curl -fsSL 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/main/etc/sonic.cfg' > sonic.cfg +curl -fsSL 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/dev/etc/sonic.cfg' > sonic.cfg # then uncomment the sonic-related sections in docker-compose.yml nano docker-compose.yml @@ -170,7 +170,7 @@ services: You can also specify an env file via CLI when running compose using `docker compose --env-file=/path/to/config.env ...` although you must specify the variables in the `environment:` section that you want to have passed down to the ArchiveBox container from the passed env file. -If you want to access your archive server with HTTPS, put a reverse proxy like Nginx or Caddy in front of `http://127.0.0.1:8000` to do SSL termination. Here is an example [ArchiveBox nginx container](https://github.com/ArchiveBox/ArchiveBox/blob/main/docker-compose.yml#:~:text=nginx) + [`nginx.conf`](https://github.com/ArchiveBox/ArchiveBox/blob/main/etc/nginx.conf) that you can modify to add your preferred TLS settings. +If you want to access your archive server with HTTPS, put a reverse proxy like Nginx or Caddy in front of `http://127.0.0.1:8000` to do SSL termination. Here is an example [ArchiveBox nginx container](https://github.com/ArchiveBox/ArchiveBox/blob/dev/docker-compose.yml#:~:text=nginx) + [`nginx.conf`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/etc/nginx.conf) that you can modify to add your preferred TLS settings.
@@ -272,4 +272,4 @@ docker run -it -v $PWD:/data -e FETCH_SCREENSHOT=False archivebox/archivebox add # OR echo 'FETCH_SCREENSHOT=False' >> ./.env docker run ... --env-file=./.env archivebox/archivebox ... -``` \ No newline at end of file +``` diff --git a/Install.md b/Install.md index 193cba4..e2cb334 100644 --- a/Install.md +++ b/Install.md @@ -62,8 +62,8 @@ It's also recommended to use a filesystem with compression and/or [deduplication > You can also run Dockerized ArchiveBox using [UNRAID/TrueNAS/Proxmox/etc.](https://github.com/ArchiveBox/ArchiveBox#-other-options) or [Kubernetes](https://github.com/ArchiveBox/docker-archivebox/blob/master/archivebox.yml). **More info:** -- [`Dockerfile`](https://github.com/ArchiveBox/ArchiveBox/blob/main/Dockerfile) -- [`docker-compose.yml`](https://github.com/ArchiveBox/ArchiveBox/blob/main/docker-compose.yml) +- [`Dockerfile`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/Dockerfile) +- [`docker-compose.yml`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/docker-compose.yml) - [`archivebox-kubernetes.yml`](https://github.com/ArchiveBox/docker-archivebox/blob/master/archivebox.yml) - [ArchiveBox Docker Quickstart](https://github.com/ArchiveBox/ArchiveBox#quickstart) + [Usage](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker) + [Configuration](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker#configuration) + [Upgrading](https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives) documentation @@ -82,7 +82,7 @@ If you're on Linux with `apt`, FreeBSD with `pkg`, or macOS with `brew` there is ```bash curl -fsSL 'https://get.archivebox.io' | sh -# shortcut to run https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/main/bin/setup.sh +# shortcut to run https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/stable/bin/setup.sh ``` The script explains what it installs beforehand, and will prompt for user confirmation before making any changes to your system. The script uses Docker if already installed, but you can decline and it will attempt to auto-install everything using `apt`/`brew`/`pkg` + `pip` instead. diff --git a/Troubleshooting.md b/Troubleshooting.md index 88aa82a..75ed31e 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -109,7 +109,7 @@ npm --version # make sure you have npm installed cd ~/archivebox/data # go into your data directory archivebox setup # auto-installs all JS dependencies into ./node_modules # equivalent to: -# curl -fsSL 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/main/archivebox/package.json' > package.json +# curl -fsSL 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/stable/archivebox/package.json' > package.json # npm install # install npm dependencies should then be present in ~/archivebox/data/node_modules/.bin @@ -186,4 +186,4 @@ See here for more info: - https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#python-shell-usage - https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#sql-shell-usage - https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#do-not-run-as-root -- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#output-folder \ No newline at end of file +- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#output-folder