Update README.md

2025-02-09 22:59:38 +00:00
parent 43dc503147
commit 62a0908acf
1 changed files with 133 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,134 @@
-# docker-archivewarrior
+# Archive Team Warrior Dockerfile

+<img alt="Warrior logo" src="https://wiki.archiveteam.org/images/f/f3/Archive_team.png" height="100px"><img alt="Docker logo" src="https://wiki.archiveteam.org/images/7/79/Docker_%28container_engine%29_logo.png" height="100px">
+
+A Dockerfile for the [Archive Team Warrior](https://wiki.archiveteam.org/index.php?title=ArchiveTeam_Warrior)
+
+Build, run, grab the container IP and access the web interface on port 8001.
+
+## Getting Started
+
+Available as a built image at `atdr.meo.ws/archiveteam/warrior-dockerfile`.
+
+The following example:
+- Runs the Warrior in the background
+- Configures Warrior to automatically start it again after machine reboot
+- And configures Watchtower to automatically update Warrior (optional, but recommended).
+
+```bash
+docker run --detach \
+  --name watchtower \
+  --restart=on-failure \
+  --volume /var/run/docker.sock:/var/run/docker.sock \
+  containrrr/watchtower --label-enable --cleanup --interval 3600
+
+docker run --detach \
+  --name archiveteam-warrior \
+  --label=com.centurylinklabs.watchtower.enable=true \
+  --restart=on-failure \
+  --publish 8001:8001 \
+  atdr.meo.ws/archiveteam/warrior-dockerfile
+```
+
+On Windows (CMD), replace `\` with `^` like so:
+
+```bash
+docker run --detach ^
+  --name watchtower ^
+  --restart=on-failure ^
+  --volume /var/run/docker.sock:/var/run/docker.sock ^
+  containrrr/watchtower --label-enable --cleanup --interval 3600
+
+docker run --detach ^
+  --name archiveteam-warrior ^
+  --label=com.centurylinklabs.watchtower.enable=true ^
+  --restart=on-failure ^
+  --publish 8001:8001 ^
+  atdr.meo.ws/archiveteam/warrior-dockerfile
+```
+On Windows (PowerShell), replace `\` (in the Linux example) with `` ` ``.
+
+To easily access the Warrior's web interface of multiple containers, try binding a different port for each subsequent container by incrementing `--publish` in your `docker run` command for the Warrior like so:
+
+```bash
+docker run --detach \
+  --env DOWNLOADER="your name" \
+  --env SELECTED_PROJECT="auto" \
+  --name archiveteam-warrior \
+  --label=com.centurylinklabs.watchtower.enable=true \
+  --restart=on-failure \
+  --publish 8002:8001 \
+  atdr.meo.ws/archiveteam/warrior-dockerfile
+```
+
+## Configuration
+
+Configuration of Warrior can be done in one of three ways:
+- Manually via the web interface.
+- Via environment variables.
+- Or via a configuration file (`projects/config.json`).
+
+### Manual Using the Web Interface
+
+To access the web interface get the container IP from `docker inspect` and point your browser to `http://IP:8001`. If you are running this container on a headless machine, be sure to bind the docker container's port to a port on that machine (e.g. `-p 8001:8001`) so that you can access the web interface on your LAN.
+
+You can stop and resume the Warrior with `docker stop` and `docker start`
+
+### Using Environment Variables
+
+If you don't mount a `projects/config.json` configuration, you can provide seed settings using
+environment variables. Once a `projects/config.json` file exists, environment variables
+will be ignored.
+
+For example, to specify environment variables, modify your `docker run` command for the Warrior like so:
+
+```bash
+docker run --detach \
+  --env DOWNLOADER="your name" \
+  --env SELECTED_PROJECT="auto" \
+  --name archiveteam-warrior \
+  --label=com.centurylinklabs.watchtower.enable=true \
+  --restart=on-failure \
+  --publish 8001:8001 \
+  atdr.meo.ws/archiveteam/warrior-dockerfile
+```
+
+### Configuration Mapping
+
+| ENV                  | JSON key             | Example           | Default |
+|----------------------|----------------------|-------------------|---------|
+| DOWNLOADER           | downloader           |                   |         |
+| HTTP_PASSWORD        | http_password        |                   |         |
+| HTTP_USERNAME        | http_username        |                   |         |
+| SELECTED_PROJECT     | selected_project     | `auto`, `tumblr`  |         |
+| SHARED_RSYNC_THREADS | shared:rsync_threads |                   | `20`    |
+| WARRIOR_ID           | warrior_id           |                   |         |
+| CONCURRENT_ITEMS     | concurrent_items     |                   | `3`     |
+
+## Other Ways to Run
+
+### Kubernetes
+
+Edit the environment variable `DOWNLOADER` inside `k8s-warrior.yml` and set it to your name. This name will be used on the leaderboards.
+
+```bash
+kubectl create namespace archive
+kubectl apply -n archive -f k8s-warrior.yml
+```
+
+If everything works out you should be able to connect to any of your k8s' nodes IP on port 30163 to view.
+
+You can build the image on other platforms by using [`docker buildx`](https://github.com/docker/buildx), e.g.:
+
+```bash
+docker buildx build -t <yourusername>/archive-team-warrior:latest --platform linux/arm/v7 --push .
+```
+
+### Docker Compose
+
+First edit the `docker-compose.yml` file with any configuration keys (as described above). When configured to your liking, use `docker compose` to start both Warrior and Watchtower.
+
+```bash
+cd examples
+docker compose up -d
+```