warrior-dockerfile: A Shell repository from penyuan

A Dockerfile for the Archive Team Warrior

Build, run, grab the container IP and access the web interface on port 8001.

Available as a built image at atdr.meo.ws/archiveteam/warrior-dockerfile. To run the Warrior in the background, automatically start it again after machine reboot, and automatically update dependencies updates (via Watchtower), simply just

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:

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 \ 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:

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

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. Please note: This is currently not available in the Raspberry PI image.

Example:

To specify environment variables, modify your docker run command for the Warrior like so:

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

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`

Raspberry Pi

You can build the container with the following command:

docker build --rm -t warrior-arm32v5:latest -f Dockerfile.raspberry .

The image needs a place to store the downloaded data as well as its configuration. Say you have a location suitable at /var/local/warrior use the command below, otherwise update the data and config.json paths.

First, create an empty config.json if it doesn't exist. Otherwise when you mount the path with docker it will create it as a directory.

touch /var/local/warrior/config.json

Now start the container.

docker run \
	--volume /var/local/warrior/data:/data/data \
	--volume /var/local/warrior/config.json:/home/warrior/projects/config.json \
	--publish 8001:8001 \
	--restart unless-stopped \
	warrior-arm32v5:latest

Kubernetes

Edit the environment variable DOWNLOADER inside warrior.yml and set it to your name. This name will be used on the leaderboards.

kubectl create namespace archive
kubectl apply -n archive -f 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 (e.g. Raspberry Pi here for example) by using docker buildx, e.g.:

docker buildx build -t <yourusername>/archive-team-warrior:latest --platform linux/arm/v7 --push .

penyuan/warrior-dockerfile