Difference between revisions of "ArchiveTeam Warrior/Docker environment variables"

From Archiveteam
Jump to navigation Jump to search
m (JustAnotherArchivist moved page Docker environment properties to ArchiveTeam Warrior/Docker environment properties without leaving a redirect)
m (These are (virtually always) called 'environment variables')
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
The ArchiveTeam Warrior docker image supports the following environment properties:
The ArchiveTeam Warrior docker image supports the following environment variables:


* <code>DOWNLOADER</code>: Nickname to show your results on our tracker. Letters and numbers only.
* <code>DOWNLOADER</code>: Nickname to show your results on our tracker. Letters and numbers only.
Line 9: Line 9:
* <code>WARRIOR_ID</code>: ?
* <code>WARRIOR_ID</code>: ?


Docker environment properties are set with the [https://docs.docker.com/engine/reference/commandline/run/#env <code>--env</code>] (or <code>-e</code>) command line flag, for example <code>-e SELECTED_PROJECT=auto</code>.
Docker environment variables are set with the [https://docs.docker.com/engine/reference/commandline/run/#env <code>--env</code>] (or <code>-e</code>) command line flag, for example <code>-e SELECTED_PROJECT=auto</code>.


These values are written to <code>/home/warrior/projects/config.json</code> by [https://github.com/ArchiveTeam/warrior-dockerfile/blob/master/env-to-json.sh env-to-json.sh] and used for the initial values when the image starts up. They can be changed later via the web interface.
These values are written to <code>/home/warrior/projects/config.json</code> by [https://github.com/ArchiveTeam/warrior-dockerfile/blob/master/env-to-json.sh env-to-json.sh] and used for the initial values when the image starts up. They can be changed later via the web interface.

Latest revision as of 20:39, 30 March 2023

The ArchiveTeam Warrior docker image supports the following environment variables:

  • DOWNLOADER: Nickname to show your results on our tracker. Letters and numbers only.
  • HTTP_USERNAME: Optional username to protect the web interface, leave unset to disable.
  • HTTP_PASSWORD: Optional password to protect the web interface, leave unset to disable.
  • SELECTED_PROJECT: Project to work on. Set to auto for ArchiveTeam’s Choice, or retrieve the value from /home/warrior/projects/config.json for other projects.
  • CONCURRENT_ITEMS: How many items should the warrior download at a time? (Default: 2, Max: 6)
  • SHARED_RSYNC_THREADS: The maximum number of concurrent uploads.
  • WARRIOR_ID: ?

Docker environment variables are set with the --env (or -e) command line flag, for example -e SELECTED_PROJECT=auto.

These values are written to /home/warrior/projects/config.json by env-to-json.sh and used for the initial values when the image starts up. They can be changed later via the web interface.