Archive Team Warrior Dockerfile

To deploy the Warrior on Kubernetes, use the provided k8s-warrior.yml manifest.

1. Edit k8s-warrior.yml to set the DOWNLOADER environment variable to your name (this name appears on leaderboards).
2. Create a namespace and apply the manifest.
3. Access the web interface via any Kubernetes node's IP on port 30163.

kubectl create namespace archive
kubectl apply -n archive -f k8s-warrior.yml

The repository includes a docker-compose.yml file in the examples directory that sets up both the Warrior and Watchtower.

1. Navigate to the examples directory.
2. Edit docker-compose.yml to configure your desired settings.
3. Run the following command to start the services in the background.

cd examples
docker compose up -d

The Warrior provides a web interface for manual configuration and monitoring.

1. Locate the IP: Use docker inspect to find the container's IP address.
2. Access via Browser: Navigate to http://<CONTAINER_IP>:8001.

Note for Headless/Remote Machines: If running on a remote machine, you must bind the container port to the host port using the -p 8001:8001 flag in your docker run command to access the interface over your LAN.

You can provide seed settings using environment variables during docker run. Note that if a projects/config.json file is mounted/exists, environment variables will be ignored.

Use the --env flag to set configuration. For example, to set your downloader name and select a specific project:

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

The provided Docker Compose setup uses watchtower to automatically update the archiveTeamWarrior container.

To enable this behavior for your own services in this environment:

1. Ensure the watchtower service is running with the --label-enable flag.
2. Add the label com.centurylinklabs.watchtower.enable: "true" to the container you wish to update.

The start.py entrypoint script allows configuring the Warrior service using environment variables. If the configuration file projects/config.json does not exist, the script will generate it using the values provided in the following environment variables. Once generated, these values are persisted in the JSON file.

Use these variables to define the downloader type, authentication credentials, the active project, and performance tuning parameters.

# Example of setting environment variables for the container
export DOWNLOADER="some-downloader"
export HTTP_USERNAME="user"
export HTTP_PASSWORD="pass"
export SELECTED_PROJECT="project-name"
export SHARED_RSYNC_THREADS="4"
export WARRIOR_ID="unique-id"
export CONCURRENT_ITEMS="10"

The following environment variables can be used to configure the Warrior. These map to specific keys in the projects/config.json file.

| 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`     |

The following environment variables are used to populate projects/config.json if it is missing:

{
  "downloader": "",
  "http_username": "",
  "http_password": "",
  "selected_project": "",
  "shared:rsync_threads": "",
  "warrior_id": "",
  "concurrent_items": ""
}