Difference between revisions of "ArchiveTeam Warrior"

From Archiveteam
Jump to navigation Jump to search
(Make Docker command explanations collapsed by default, add explanation of Watchtower image address)
m (Un-abbreviate --volume in Docker command)
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{notice|1=Version 3.2 of the Warrior VM Appliance has been released! This update enables running newer projects, shortens startup times, enables viewing basic logs from the virtual machine console (press ALT+F2 for Warrior logs, press ALT+F3 for automatic updater logs, and press ALT+F1 to return to the splash screen), and has other minor improvements. Warriors versions 3.0 and 3.1 will automatically update themselves with the project compatibility improvements, but the other improvements require re-creating the VM with version 3.2 of the appliance.
{{notice|1=The current versions of the Warrior Docker image and the Warrior virtual machine image should now be compatible with most projects; however some projects may still not be compatible and show a blank screen when attempting to run them. As an alternative, you can [[Running_Archive_Team_Projects_with_Docker|run individual projects manually using Docker]].


The Warrior should now be compatible with most projects; however some projects may still not be compatible and show a blank screen when attempting to run them.
If you have any issues or feedback, see the [[Archiveteam:IRC|AT #warrior IRC channel on hackint]].}}


In place of the Warrior, you may manually run projects using Docker. (If you like, you can run Docker in a VM of your own choosing. Recent Ubuntu versions are known to work.) For further info, see our guide to [[Running_Archive_Team_Projects_with_Docker|Running Archive Team Projects with Docker]] and also see the project's Readme instructions in the [https://github.com/ArchiveTeam/ ArchiveTeam GitHub repositories]. If you have any issues or feedback, see the [[Archiveteam:IRC|AT #warrior IRC channel on hackint]].}}
== What is the Archive Team Warrior? ==
 
==What is the Archive Team Warrior?==


[[Image:Archive_team.png|100px|left]]
[[Image:Archive_team.png|100px|left]]
Line 12: Line 10:
[[File:Archiveteam_warrior_infrastructure.png|thumb|right|256px|[[Dev/Infrastructure|Warrior infastructure]]]]
[[File:Archiveteam_warrior_infrastructure.png|thumb|right|256px|[[Dev/Infrastructure|Warrior infastructure]]]]


The Archive Team Warrior is a virtual archiving appliance. You can run it to help with the Archive Team archiving efforts. It will download sites and upload them to our archive — and it’s really easy to do!
The Archive Team Warrior is a virtual archiving appliance. You can run it to help with the Archive Team archiving efforts. It will download sites and upload them to our archive—and it’s really easy to do!


The warrior is a virtual machine, so there is no risk to your computer. The warrior will only use your bandwidth and some of your disk space.  It will get tasks from and report progress to the [[Tracker]].
The warrior is a container running inside a virtual machine, so there is no risk to your computer. The warrior will only use your bandwidth and some of your disk space.  It will get tasks from and report progress to the [[Tracker]].


== Basic usage ==
== Basic usage ==
The Warrior runs on Windows, macOS, and Linux. You can run it using a virtual machine (simplest) or using Docker (far less overhead than a VM, a little more complicated to set up but still fairly simple).


=== Using a Virtual Machine ===
The Warrior runs on Windows, macOS, and Linux. You can run it using a virtual machine (simplest) or using Docker (slightly more complicated, but much less overhead than the VM).
 
=== Installing and running with a virtual machine ===


You'll need:
You'll need:
Line 27: Line 26:
** [https://www.syping.de/archiveteam/ Syping Development (DE)] (outdated but still functional)
** [https://www.syping.de/archiveteam/ Syping Development (DE)] (outdated but still functional)
** [https://archive.org/details/archiveteam-warrior-v3-20171013 Internet Archive] (outdated but still functional)
** [https://archive.org/details/archiveteam-warrior-v3-20171013 Internet Archive] (outdated but still functional)
Plus one of the virtualization applications below to run it:
* A virtualization application to run it, such as:
* [https://www.virtualbox.org/ VirtualBox] (recommended, open source)  
** [https://www.virtualbox.org/ VirtualBox] (recommended, open source)  
* [https://www.vmware.com/products/player/ VMware workstation/player] (may have some compatibility issues, free-gratis for personal use)
** [https://www.vmware.com/products/player/ VMware Player] (may have some compatibility issues, free-gratis for personal use)


==== Quick start instructions for VirtualBox ====
==== VirtualBox ====
 
A [https://www.youtube.com/watch?v=_nzD-QpmePE video demonstrating these steps] is available. (Note that the screen indicating that the Warrior has finished loading looks different than the one from when this video was made, but the steps are otherwise the same.)


# Download the appliance from the link above.
# Download the appliance from the link above.
# Launch VirtualBox
# Launch VirtualBox.
# In VirtualBox, click File > Import Appliance and open the file.
# In VirtualBox, click <code>File > Import Appliance</code> and open the file.
# Start the virtual machine.
# Start the virtual machine.
#* It will fetch the latest updates and will eventually tell you to start your web browser.
#* It will fetch the latest updates and will eventually tell you to start your web browser.
# Using your regular web browser, visit http://localhost:8001/
# Using your regular web browser, visit http://localhost:8001/.
# On the left, click "Your settings".
 
# Choose a username - we'll show your progress on the [[tracker|leaderboard]].
A [https://www.youtube.com/watch?v=_nzD-QpmePE video demonstrating these steps] is available. (Note that the screen indicating that the Warrior has finished loading looks different than the one from when this video was made, but the steps are otherwise the same.)
# On the left, click "Available projects" tab and pick a project to work on.
#* Even better: select "ArchiveTeam's Choice" to let your warrior work on the most urgent project.


==== Start instructions for VMWare Player ====
==== VMWare Player ====
Note that VMWare Player may have some compatibility issues with running the Warrior image.
Note that VMWare Player may have some compatibility issues with running the Warrior image.


# Download the appliance from the link above
# Download the appliance from the link above.
# Launch VMWare Player
# Launch VMWare Player.
# In Player on the right, click "Open Virtual Machine", open the file and import the virtual machine.
# In Player on the right, click "Open Virtual Machine", open the file and import the virtual machine.
# (Optional) Select the virtual machine and click "Edit virtual machine settings".
# (Optional) Select the virtual machine and click "Edit virtual machine settings".
Line 57: Line 52:
#* It will fetch the latest updates and will eventually tell you to start your web browser.
#* It will fetch the latest updates and will eventually tell you to start your web browser.
# Using your regular web browser, visit the address that is shown on the bottom (e.g. http://192.168.0.100:8001/)
# Using your regular web browser, visit the address that is shown on the bottom (e.g. http://192.168.0.100:8001/)
# On the left, click "Your settings".
# Choose a username - we'll show your progress on the [[tracker|leaderboard]].
# On the left, click "Available projects" tab and pick a project to work on.
#* Even better: select "ArchiveTeam's Choice" to let your warrior work on the most urgent project.


=== Using Docker ===
=== Installing and running with Docker ===


Docker runs on Windows, macOS, and Linux, and is a [https://docs.docker.com/get-docker/ free download]. Docker runs code in '''containers''', and stores code in '''images'''. (Docker requires the professional version of Windows if being run on versions of Windows prior to Windows 10 version 1903.)
You'll need [https://docs.docker.com/get-docker/ Docker] (open source) and the Warrior Docker image.


Instructions for running the Warrior using Docker are below. For additional FAQ and instructions for running individual project scripts using Docker, see [[Running_Archive_Team_Projects_with_Docker|Running Archive Team Projects with Docker]].
# Download Docker from the link above and install it.
 
# Open your terminal. On Windows, you can use either Command Prompt (CMD) or PowerShell. On macOS and Linux you can use Terminal (Bash).
==== Instructions for using Docker CLI on Windows, macOS, or Linux ====
# Use the following command to start the Warrior as well as Watchtower, which will automatically keep your Warrior updated: <pre>docker run --detach --name watchtower --restart=unless-stopped --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=unless-stopped --publish 8001:8001 atdr.meo.ws/archiveteam/warrior-dockerfile</pre> (For a full explanation of this command, see items 3 and 4  [[Running_Archive_Team_Projects_with_Docker#Instructions_for_using_Docker_CLI_on_Windows.2C_macOS.2C_or_Linux|here]].)
 
# Using your regular web browser, visit http://localhost:8001/.
# Download and install Docker from the link above.
# Open your terminal. On Windows, you can use either Command Prompt (CMD) or PowerShell, on macOS and Linux you can use Terminal (Bash).
# First, we will set up the [https://containrrr.dev/watchtower/ Watchtower] container. Watchtower automatically checks for updates to Docker containers every hour, and if an update is found, it will gracefully shutdown your container, update it, and restart it.<br />Use the following command:<pre>docker run -d --name watchtower --restart=unless-stopped -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --label-enable --cleanup --interval 3600</pre>Command Explanation: <div class="mw-collapsible mw-collapsed" style="overflow:auto;">
#* <code>-d</code>: Detaches the container from the terminal and runs it in the background.
#* <code>--name watchtower</code>: The name that is displayed for the container. A name other than "watchtower" can be specified here if needed.
#* <code>--restart=unless-stopped</code>: This tells Docker to restart the container unless you stop it. This also means that it will restart the container automatically when you reboot your system.
#* <code>-v /var/run/docker.sock:/var/run/docker.sock</code>: This provides the Watchtower container access to your system's Docker socket. Watchtower uses this to communicate with Docker on your system to gracefully shutdown and update your containers.
#* <code>containrrr/watchtower</code>: This is the Docker image address for Watchtower.
#* <code>--label-enable</code>: This tells Watchtower only to update containers that are specifically tagged for auto-updating. This is included to prevent Watchtower from updating any other containers you may have running on your system. If you are only using Docker to run Archive Team projects, or wish to automatically update all containers including those that are not for Archive Team projects, you can leave this off.
#* <code>--cleanup</code>: This tells Watchtower to delete old, outdated Docker images, which helps save disk space on your system.
#* <code>--interval 3600</code>: This tells Watchtower to check for updates to your Docker containers every hour.</div>
# Now we will set up the Warrior container.<br />Use the following command:<pre>docker run -d --name archiveteam-warrior --label=com.centurylinklabs.watchtower.enable=true --restart=unless-stopped -p 8001:8001 atdr.meo.ws/archiveteam/warrior-dockerfile</pre>Command Explanation: <div class="mw-collapsible mw-collapsed" style="overflow:auto;">
#* <code>-d</code>: Detaches the container from the terminal and runs it in the background.
#* <code>--name archiveteam-warrior</code>: The name that is displayed for the container. A name other than "archiveteam-warrior" can be specified here if needed (e.g. you want to create multiple containers using the same image).
#* <code>--label=com.centurylinklabs.watchtower.enable=true</code>: Labels the container to be automatically updated by Watchtower. You can leave this off if you did not include <code>--label-enable</code> when launching the Watchtower container.
#* <code>--restart=unless-stopped</code>: This tells Docker to restart the container unless you stop it. This also means that it will restart the container automatically when you reboot your system.
#* <code>-p 8001:8001</code>: This tells Docker to make port 8001 from the container available on your system at http://localhost:8001. This allows you to use your web browser to monitor and configure your Warrior.
#* <code>atdr.meo.ws/archiveteam/warrior-dockerfile</code>: This is the Docker image address for the Warrior.</div>
# The Warrior will download and start up. It will automatically restart when your system is restarted unless you stop the container.
# When the command finishes, use your regular web browser to visit http://localhost:8001/
# On the left, click "Your settings".
# Choose a username - we'll show your progress on the [[tracker|leaderboard]].
# On the left, click "Available projects" tab and pick a project to work on.
#* Even better: select "ArchiveTeam's Choice" to let your warrior work on the most urgent project.
 
{{notice|1=On Windows and macOS, once you have completed steps 1-4, you can also start, stop, and delete containers in the Docker Desktop UI. However, for the time being, initial setup can only be done from the command line. Docker on Linux (either in a VM or on bare metal hardware) is the recommended way to run Docker containers.}}
 
==== Stopping Docker containers ====
# '''Recommended method:''' Attempt graceful stop by sending the SIGINT signal, with no hard-kill deadline:<br><code>docker kill --signal=SIGINT archiveteam-warrior</code><br>Command Explanation: <div class="mw-collapsible mw-collapsed" style="overflow:auto;">
#* <code>kill</code>: Docker's command for killing a container, defaults to sending a SIGKILL signal unless otherwise specified
#* <code>--signal=SIGINT</code>: tells Docker to send a SIGINT signal to the container (not a SIGKILL)<br>
#* <code>archiveteam-warrior</code>: This is the name of the Docker container(s) that need to be stopped. If needed, replace with the actual container name(s) you want to stop. Multiple containers can be stopped with the same command.<br></div>
# '''Alternate, unrecommended method:''' Attempt stop, with a hard-kill deadline of 1 hour:<br><code>docker stop -t 3600 archiveteam-warrior</code><br>Command Explanation: <div class="mw-collapsible mw-collapsed" style="overflow:auto;">
#* <code>-t 3600</code>: tells Docker to wait for 3600 seconds (60 minutes) before forcibly stopping the container. Docker's default is <code>-t 10</code> (not recommended). Use <code>-t 0</code>to stop immediately (also not recommended). Hard-kill deadlines are problematic because large multi-GB projects may require long-running jobs (e.g. 48 hours for content download + additional hours of rsync upload time that itself may be delayed by upload bandwidth limits and/or congestion on the rsync target). Please ask in the project [[Archiveteam:IRC|IRC]] channel if you are considering using a hard-kill method, especially for projects where there may not be time for another worker to retry later. (There may be interest in recovering/saving partial WARCs from containers that did not end gracefully.) Also see the FAQ entry about ungraceful stops.<br>
#* <code>archiveteam-warrior</code>: This is the name of the Docker container(s) that need to be stopped. If needed, replace with the actual container name(s) you want to stop. Multiple containers can be stopped with the same command.<br></div>
 
The same commands can also be used to stop the <code>watchtower</code> container.
 
==== Starting Docker containers ====
Similarly, to start your containers again in the future, run <code>docker start watchtower archiveteam-warrior</code>. If needed, replace "watchtower" and "archiveteam-warrior" with the actual container names you used.
 
==== Deleting Docker containers ====
To delete a container, run <code>docker rm archiveteam-warrior</code>. If needed, replace "archiveteam-warrior" with the name of the actual container you want to delete. To free up disk space, you can also purge your unused Docker images by running <code>docker image prune</code>. Note that this command will delete all Docker images on your system that are not associated with a container, not just Archive Team ones.




Line 118: Line 66:


== Warrior FAQ ==
== Warrior FAQ ==
For additional FAQ for running the Warrior using Docker, see [[Running_Archive_Team_Projects_with_Docker|Running Archive Team Projects with Docker]].


=== Why a virtual machine/Docker container in the first place? ===
=== Why a virtual machine/container in the first place? ===


The virtual machine is a quick, safe, and easy way for newcomers to help us out. It offers many features:
The Warrior is a quick, safe, and easy way for newcomers to help us out. It offers many features:


* Graphical interface (Virtual Machine only)
* Graphical interface (virtual machine only)
* Automatically selects which project is important to run
* Automatically selects which project is important to run
* Self-updating software infrastructure
* Self-updating software infrastructure
Line 132: Line 79:
* Runs on Windows, Mac, and Linux painlessly
* Runs on Windows, Mac, and Linux painlessly
* Ensures consistency in the archived data regardless of your machine's quirks
* Ensures consistency in the archived data regardless of your machine's quirks
* Restarts automatically after a system restart (Docker container only)
* Can be configured to restart automatically after a system restart ([[#How can I set up the Warrior to start up on boot and shut down automatically?|see below]]).


If you have suggestions for improving this system, please talk to us as described below.
If you have suggestions for improving this system, [[#I_still_have_a_question.21|talk to us]].


=== Can I use whatever internet access for the Warrior? ===
=== Can I use whatever internet access for the Warrior? ===
Line 150: Line 97:
* We prefer connections from many public IP addresses if possible. (For example, if your apartment building uses a single IP address, we don't want your apartment banned.)
* We prefer connections from many public IP addresses if possible. (For example, if your apartment building uses a single IP address, we don't want your apartment banned.)


=== I turned my Warrior VM/Docker appliance off. Will those tasks be lost? ===
=== I turned my Warrior off. Will those tasks be lost? ===


If you've killed your Warrior VM/Docker instance, then the work your Warrior did has been lost. However, the tasks will be returned to the pool after a period of time, and other warriors may claim them.
If you've killed your Warrior, then the work it was doing has been lost. However, the tasks will be returned to the pool after a period of time, and other warriors may claim them.


=== I closed my browser or tab with the Warrior's web interface. Will those tasks be lost? ===
=== I closed my browser or tab with the Warrior's web interface. Will those tasks be lost? ===
Line 158: Line 105:
No. The web browser interface just provides a user interface to the Warrior. As long as the VM or Docker container is not stopped, it will continue normally.
No. The web browser interface just provides a user interface to the Warrior. As long as the VM or Docker container is not stopped, it will continue normally.


=== I need to disconnect my internet / reboot my PC. How can I do this without losing work?===
=== How can I shut down the Warrior without losing work? ===


If you pause/suspend the Warrior VM instance, most projects will allow resuming of work in progress when you unsuspend the warrior VM instance.
==== Recommended method ====


If you decide to use the suspend VM feature, please note that if you keep it suspended for too long (more than a few hours), the administrators will assume that the item is lost and re-queue it. Using the suspend feature so that you can reboot your computer is perfectly fine.
Click the "Shut down" button on the left of the web interface. All the current tasks will still finish, but no new ones will be started. When a banner appears saying "There is no connection with the warrior", the Warrior has finished shutting down. (If you would rather use the command line than the web interface, [[#How_can_I_run_the_Warrior_headlessly_.28without_leaving_a_window_open.29.3F|see below]]).


Docker does not have a feature for suspending containers. If you want to disconnect your internet or reboot your PC without losing work, try to [[#Stopping_Docker_containers|gracefully stop the container]] by using the recommended method for stopping Docker containers, and then start the container again when you are ready to resume work.
==== Suspend/resume with the virtual machine ====


=== How much disk space will the warrior use? ===
If you don't want to wait (perhaps because a task is long-running), you can use VirtualBox's <code>Machine > Pause</code> or VMWare's <code>VM > Pause</code> to suspend the Warrior VM, then resume it when you are ready to work again. Note that if you keep it suspended for too long (more than a few hours), the tracker will assume that the item is lost and re-queue it—but suspending in order to reboot your computer or reset your internet connection should be perfectly fine.
 
==== Suspend/resume with the Docker container ====
 
If you don't want to wait, you're out of luck; Docker does not have a feature for suspending containers.
 
=== How much disk space will the Warrior use? ===


Short answer: it depends on the project. The virtual machine has a hard limit of 60GB disk usage, but the Docker container does not have such a limit. However, it is highly unlikely that any project would use more than 60GB of disk space at any time.
Short answer: it depends on the project. The virtual machine has a hard limit of 60GB disk usage, but the Docker container does not have such a limit. However, it is highly unlikely that any project would use more than 60GB of disk space at any time.


Long answer: because each project defines items differently, sizes may vary. A single task may be a small file or a whole subsection of a website. The virtual machine is configured by default to use an absolute maximum of 60GB, but Docker has no hard limit. Any unused virtual machine/Docker container disk space is not used on the host computer. You may run the virtual machine on less than 60GB if you like to live dangerously. We're downloading the internet, after all!
Long answer: because each project defines items differently, sizes may vary. A single task may be a small file or a whole subsection of a website. The virtual machine is configured by default to use an absolute maximum of 60GB, but Docker has no hard limit. Any unused virtual machine or Docker container disk space is not used on the host computer. You may configure the virtual machine to run on less than 60GB if you like to live dangerously. We're downloading the internet, after all!
 
=== How can I log into the Warrior? ===


=== How can I log into the virtual machine/Docker container? ===
Unless you know what you are doing, you should not need to do this.  
Unless you know what you are doing, you should not need to do this.  


To log into the virtual machine, start up the Warrior VM and wait for it to finish booting with the screen showing "The warrior has successfully started up". Press ALT+F4 to switch to virtual console number 4. VirtualBox users may need to press the host key, RIGHT_CONTROL to enter capture mode before pressing ALT+F4. Use ALT+Left or ALT+Right to switch between virtual consoles. There are 6 virtual consoles in total. Consoles 1, 2, and 3 are reserved for the warrior. Switching to a new virtual console will show a login shell. You can login using the username <code>root</code> and the password <code>archiveteam</code>.
==== Virtual machine ====


To bring up a command shell inside the Docker container, open your terminal and run <code>sudo docker exec -t -i archiveteam-warrior /bin/bash</code>. Replace 'archiveteam-warrior' with the name of your Warrior container if necessary.
With the Warrior running, press ALT+F4 to switch to virtual console number 4. VirtualBox users may need to press the host key, RIGHT_CONTROL, to enter capture mode before pressing ALT+F4. Use ALT+Left or ALT+Right to switch between virtual consoles. There are 6 virtual consoles in total. Consoles 1, 2, and 3 are reserved for the warrior. Switching to a new virtual console will show a login shell. You can login using the username <code>root</code> and the password <code>archiveteam</code>.


=== How can I run multiple virtual machines/Docker containers at the same time? ===
==== Docker container ====


If you want to run multiple instances of a project within the same Warrior VM/Docker container, you can adjust the number of concurrent items to work on in your Warrior settings. The minimum concurrency value is 1, the default concurrency value is 3, and maximum recommended concurrency value is 5, and the maximum allowed concurrency value is 20.
With the Warrior running, open your terminal and run <code>sudo docker exec -t -i archiveteam-warrior /bin/bash</code>. Replace 'archiveteam-warrior' with the name of your Warrior container if necessary.


If you still want to run multiple virtual machines, you'll need to adjust the networking settings.
=== How can I run multiple Warriors at the same time? ===


In VirtualBox, select a virtual machine and open up Settings Network Adapter 1 Port Forwarding. You need to adjust the host port. For example, set your table to TCP | 127.0.0.1 | 8123 | | 8001. This maps port 8123 on the host machine (your computer) to port 8001 on the virtual machine (the warrior), and you can then access the warrior's web interface from port 8123 in your browser.
This usually isn't necessary; if you want to increase your work on a project, you can increase the number of items your Warrior will work on at the same time. In the web interface, go to the "Your settings" tab, tick the "Show advanced settings" box, and edit the "Concurrent items" field. The maximum concurrency is 6.
 
==== Virtual machines ====
 
You'll need to adjust the networking settings.
 
In VirtualBox, select a virtual machine and open up <code>Settings > Network > Adapter 1 > Port Forwarding</code>. You need to adjust the host port. For example, setting your table to <code>TCP | 127.0.0.1 | 8123 | | 8001</code> will map port 8123 on the host machine (your computer) to port 8001 on the virtual machine (the warrior), and you can then access the warrior's web interface from port 8123 in your browser.
 
VMWare installations should be using bridged networking. However, if you want, you can switch to NAT (under <code>Settings > Hardware > Virtual Network Adapter</code>) and click Edit to set up port forwarding. On Linux, you can also use lines like <code>8123 = 192.168.0.100:8001</code> in the <code>[incomingtcp]</code> section of nat.conf. (Make sure the VM IP is correct!)


Each VM you want to access should have a different host port. Do not use port numbers below 1024 unless you know what you are doing.
Each VM you want to access should have a different host port. Do not use port numbers below 1024 unless you know what you are doing.


VMWare installations should be using bridged networking. However, if you want, you can switch to NAT (under Settings → Hardware → Virtual Network Adapter) and click Edit to set up port forwarding. On Linux, you can also use lines like <code>8123 = 192.168.0.100:8001</code> in the <code>[incomingtcp]</code> section of nat.conf. (Make sure the VM IP is correct!)
==== Docker containers ====


If you want to run multiple Docker containers, you'll need to adjust the run command used to create them. First, each container needs a unique name, so you will need to replace the name specified with the <code>--name</code> parameter with something unique. Second, you will need to specify a unique port to access the web interface of each container. You can do this by changing the number before the <code>:</code> in the <code>-p</code> parameter to any available unique port number equal to or greater than 1024. (Additional options for specifying ports are explained in the [https://docs.docker.com/network/links/#connect-using-network-port-mapping Docker documentation].) Third, you may also want to reuse your configuration between different Docker containers. You can do this by specifying the same [https://github.com/ArchiveTeam/warrior-dockerfile#using-environment-variables environment variables] or bindmounting the same <code>config.json</code> file across all of your containers. See the [https://github.com/ArchiveTeam/warrior-dockerfile#readme Warrior Dockerfile README] for more details about this.
You'll need to adjust the run command used to create the containers.


=== How can I run the virtual machine/Docker container headlessly (without leaving a window open)? ===
First, each container needs a unique name, so you will need to replace the name specified with the <code>--name</code> parameter with something unique.


From the VirtualBox GUI, after opening the VM, click Machine > Detach GUI. You can then close the VirtualBox Manager window.
Second, you will need to specify a unique port to access the web interface of each container. You can do this by changing the number before the <code>:</code> in the <code>--publish</code> parameter to any available unique port number equal to or greater than 1024. (Additional options for specifying ports are explained in the [https://docs.docker.com/network/links/#connect-using-network-port-mapping Docker documentation].)


For the VirtualBox CLI, use this command:
You may also want to reuse your configuration between different Docker containers; you can do this by specifying the same [https://github.com/ArchiveTeam/warrior-dockerfile#using-environment-variables environment variables] or bindmounting the same <code>config.json</code> file across all of your containers. See the [https://github.com/ArchiveTeam/warrior-dockerfile#readme Warrior Dockerfile README] for more details about this.


<pre>vboxmanage startvm archiveteam-warrior-3.2 --type headless</pre>
=== How can I run the Warrior headlessly (without leaving a window open)? ===


Shut down the VM with:
==== Virtual machine ====


<pre>vboxmanage controlvm archiveteam-warrior-3.2 acpipowerbutton</pre>
From the VirtualBox GUI, after opening the VM, click <code>Machine > Detach GUI</code>. You can then close the VirtualBox Manager window.


Substituting <code>suspend</code> or <code>resume</code> for <code>acpipowerbutton</code> suspends or resumes the VM. For more information, consult [http://www.virtualbox.org/manual/ch08.html#vboxmanage-startvm the VirtualBox manual (Chapter 8, Sections 12 and 13)].
For the VirtualBox CLI, you can start up the VM with <code>VBoxManage startvm archiveteam-warrior-3.2 --type headless</code> and shut it down with <code>VBoxManage controlvm archiveteam-warrior-3.2 acpipowerbutton</code>. Substituting <code>suspend</code> or <code>resume</code> for <code>acpipowerbutton</code> suspends or resumes the VM. For more information, consult [http://www.virtualbox.org/manual/ch08.html#vboxmanage-startvm the VirtualBox manual (Chapter 8, Sections 12 and 13)].


For the VMWare CLI, use this command:
For the VMWare CLI, you can start up the VM with <code>vmrun start <path to vmx file> nogui</code> and shut it down with <code>vmrun stop <path to vmx file> soft</code>. Substituting <code>suspend</code> for <code>stop</code> suspends the VM; resume with <code>start</code> again. For more information, including the paths to VMX files on different operating systems, consult [http://www.vmware.com/pdf/vix180_vmrun_command.pdf Using vmrun to Control Virtual Machines] (PDF), pages 10 and 11.


<pre>vmrun start <path to vmx file> nogui</pre>
==== Docker container ====


Shut down with:
The container does not have a GUI, and if run with <code>--detach</code> (as the instructions suggest), it will not occupy your terminal window either. It is therefore headless by default. You can start up the container with <code>docker start archiveteam-warrior</code> and shut it down with <code>docker kill --signal=SIGINT archiveteam-warrior</code>.


<pre>vmrun stop <path to vmx file> soft</pre>
=== How can I set up the Warrior to start up on boot and shut down automatically? ===


Substituting <code>suspend</code> for <code>stop</code> suspends the VM. Resume with <code>start</code> again. For more information, including the paths to VMX files on different operating systems, consult [http://www.vmware.com/pdf/vix180_vmrun_command.pdf Using vmrun to Control Virtual Machines] (PDF), pages 10 and 11.
==== Virtual machine ====


The Docker container runs headlessly by default with no need for additional configuration.
If you are using VirtualBox and running a Linux distribution that uses the systemd init system (like most recent releases), you can set the VM up as a system service by following the short instructions on [http://www.ericerfanian.com/automatically-starting-virtualbox-vms-on-archlinux-using-systemd/ this page]. (The page title specifies Arch Linux, but this will work for other distros as long as they run systemd.)


=== How can I set up the virtual machine/Docker container as a system service (so that it starts up on boot and shuts down automatically)? ===
==== Docker container ====


If you are using VirtualBox and running a Linux distribution that uses the systemd init system (like most recent releases), you can follow the short instructions on [http://www.ericerfanian.com/automatically-starting-virtualbox-vms-on-archlinux-using-systemd/ this page]. (The page title specifies Arch Linux, but this will work for other distros as long as they run systemd.)
If the container is run with <code>--restart=unless-stopped</code> (as the instructions suggest), Docker will automatically start it on boot.
 
The Docker container runs starts on boot and shuts down automatically by default with no need for additional configuration.


=== How can I set up the virtual machine with directly-bridged networking instead of NAT? ===
=== How can I set up the virtual machine with directly-bridged networking instead of NAT? ===
Line 229: Line 189:
On VirtualBox, use these commands:
On VirtualBox, use these commands:


<pre>vboxmanage modifyvm archiveteam-warrior-2 --nic1 bridged
<pre>VBoxManage modifyvm archiveteam-warrior-3.2 --nic1 bridged
vboxmanage modifyvm archiveteam-warrior-2 --bridgeadapter1 eth0</pre>
VBoxManage modifyvm archiveteam-warrior-3.2 --bridgeadapter1 eth0</pre>


We presume you want to bind to <code>eth0</code>. Adjust as required. :)
We presume you want to bind to <code>eth0</code>. Adjust as required. :)
Line 238: Line 198:
=== How can I access the virtual machine from another device on my network? ===
=== How can I access the virtual machine from another device on my network? ===


Full guide for VirtualBox users is found [https://gist.github.com/HeliosLHC/cf3264c8d65b4680474ac13bcc6d0384 here]
Full guide for VirtualBox users is found [https://gist.github.com/HeliosLHC/cf3264c8d65b4680474ac13bcc6d0384 here].


<!--=== How can I run the warrior without a virtual machine? (The VM has too much overhead for a VPS!) ===
=== What's new in version 3.2 of the Warrior virtual machine? ===


One option is running a Docker container (see [[#Alternative_virtual_machines|above]]). Docker is based on LXC, and the overhead is far less than running a full VM. If you plan on running the [https://github.com/ArchiveTeam/warrior-dockerfile warrior-dockerfile], make sure to publish the port to allow access to the web interface:
This update enables running newer projects, shortens startup times, enables viewing basic logs from the virtual machine console (press ALT+F2 for Warrior logs, press ALT+F3 for automatic updater logs, and press ALT+F1 to return to the splash screen), and has other minor improvements. Warriors versions 3.0 and 3.1 will automatically update themselves with the project compatibility improvements, but the other improvements require re-creating the VM with version 3.2 of the appliance.


<pre>docker run -d -p 8001:8001 archiveteam/warrior-dockerfile</pre>
=== Are previous versions of the Warrior still supported? ===


This creates a direct port mapping. For host port 38001 to container port 8001, use <code>38001:8001</code>. Adjust as required. :P
==== Virtual machine ====


(Multiple projects can be also run in isolated environments (containers) for rapid deployment using [https://hub.docker.com/r/infrequent/at-as-dockerfile at-as-dockerfile].)
Currently, versions 3.0, 3.1, and 3.2 of the Warrior virtual machine are functional and supported, and are capable of automatically retrieving updated components as needed. Support for version 2 and prior of the Warrior virtual machine was discontinued around 2018 due to outdated SSL support.


Another alternative is '''running the project manually.''' If you are managing a VPS, it's likely you are comfortable with some Linux stuff. Consult the project wiki page or the source code repository readme file.
==== Docker container ====
-->
 
=== How can I run tons of warriors easily? ===
We always recommend using the latest version of the Warrior Docker image, as new and updated projects often require the updated components provided by newer Docker images. If you run the Docker container with Watchtower (as the instructions suggest), your Docker container will automatically be kept up-to-date.
 
=== How can I run tons of Warriors easily? ===


We assume you've checked with the current Archive Team project what concurrency and resources are needed or useful!
We assume you've checked with the current Archive Team project leads what concurrency and resources are needed or useful!


Whether your have your own virtual cluster or you're renting someone else's (aka a "[https://fsfe.org/activities/nocloud/ cloud]"), you probably need some [[wikipedia:Category:Orchestration_software|orchestration software]].
Whether your have your own virtual cluster or you're renting someone else's (aka a "[https://fsfe.org/activities/nocloud/ cloud]"), you probably need some [[wikipedia:Category:Orchestration_software|orchestration software]].


Archive Team volunteers have successfully used a variety of hosting providers and tools (including free trials on AWS and GCE), often just by building their own flavor of virtual server and then repeating it with simple [https://cloudinit.readthedocs.io/ cloud-init] scripts (to install and launch docker as above) or whatever tool the hosting provides. If you desire full automation, the [https://gitlab.com/diggan/archiveteam-infra archiveteam-infra repository by diggan] helps with [[wikipedia:Terraform (software)|Terraform]] on [[wikipedia:DigitalOcean|DigitalOcean]].
Archive Team volunteers have successfully used a variety of hosting providers and tools (including free trials on AWS and GCE), often just by building their own flavor of virtual server and then repeating it with simple [https://cloudinit.readthedocs.io/ cloud-init] scripts or whatever tool the hosting provides. If you desire full automation, the [https://gitlab.com/diggan/archiveteam-infra archiveteam-infra repository by diggan] helps with [[wikipedia:Terraform (software)|Terraform]] on [[wikipedia:DigitalOcean|DigitalOcean]].


Some custom monitoring scripts also exist, for instance [https://github.com/general-programming/gp-archiveteam-bs/blob/master/tumblr/watcher.py watcher.py].
Some custom monitoring scripts also exist, for instance [https://github.com/general-programming/gp-archiveteam-bs/blob/master/tumblr/watcher.py watcher.py].


You can also review instructions for [[#How_can_I_run_multiple_virtual_machines.2FDocker_containers_at_the_same_time.3F|running multiple Warrior VMs/Docker containers on one machine]] which may also be helpful here.
The instructions for [[#How_can_I_run_multiple_virtual_machines.2FDocker_containers_at_the_same_time.3F|running multiple Warriors on one machine]] may be helpful. However, you should also consider [[Running_Archive_Team_Projects_with_Docker|running Docker containers for individual projects]] rather than the Warrior; these have even less overhead and can be configured with greater concurrency.
 
=== What are the alternatives to using the Warrior? ===
 
One is [[Running_Archive_Team_Projects_with_Docker|running Docker containers for individual projects]]. This is particularly useful if you want to deploy a large amount of computing power.
 
Another is running individual projects directly. Check the source repository for the project you're interested in and follow the instructions for running without a Warrior in the README. This is particularly useful if you want to deploy on a machine where you don't have root.
 
We generally recommend that people use the Warrior, because it is simple for non-technical users to set up and it requires no supervision. You should only use these alternatives if you are comfortable with Linux and prepared to manually intervene when projects begin and end.


=== I'm looking at the leaderboard. What's that icon beside the username? ===
=== I'm looking at the leaderboard. What's that icon beside the username? ===


That's just the warrior logo: [[File:Archive_team.png|42px]] (click on the image for a larger version). It means that that person is using the warrior. Those without the icon are running the scripts manually.
That's just the warrior logo: [[File:Archive_team.png|42px]] (click on the image for a larger version). It means that that person is using the warrior. Those without the icon are running the project manually.


[[Image:Archiveteam-warrior-sticker.png‎|256px|right]]
[[Image:Archiveteam-warrior-sticker.png‎|256px|right]]
Line 274: Line 244:
The place is on fire! But don't worry, he safely escaped with the rescued data in his arms.
The place is on fire! But don't worry, he safely escaped with the rescued data in his arms.


=== That’s awesome – can I slap this logo on my laptop to show my Internet-preservation pride? ===
=== That’s awesome—can I slap this logo on my laptop to show my Internet-preservation pride? ===


[http://www.redbubble.com/people/ajhajh/works/12857655-archive-team-warrior-stickers?p=sticker You sure can!] The ArchiveTeam Warrior laptop sticker can start conversations about archiving, if you’re into that.
[http://www.redbubble.com/people/ajhajh/works/12857655-archive-team-warrior-stickers?p=sticker You sure can!] The ArchiveTeam Warrior laptop sticker can start conversations about archiving, if you’re into that.
Line 303: Line 273:
-->
-->
=== I can't connect to localhost. ===
=== I can't connect to localhost. ===
==== Virtual machine ====


The application is configured to set up port forwarding to the guest machine, and you should be able to access the interface through your web browser at port 8001. If this does not happen, and isn't resolved by rebooting the warrior (using the ACPI power signals, not suspend/save state and resume), you may need to double-check your machine's network settings (as described [[#How_can_I_run_multiple_virtual_machines_at_the_same_time.3F|above]]).
The application is configured to set up port forwarding to the guest machine, and you should be able to access the interface through your web browser at port 8001. If this does not happen, and isn't resolved by rebooting the warrior (using the ACPI power signals, not suspend/save state and resume), you may need to double-check your machine's network settings (as described [[#How_can_I_run_multiple_virtual_machines_at_the_same_time.3F|above]]).
==== Docker container ====
Make sure you invoked <code>docker run</code> with the option <code>--publish</code>. To access the web interface at http://localhost:X/, you must use <code>--publish X:8001</code>.


=== The warrior can't connect to the internet. ===
=== The warrior can't connect to the internet. ===
Line 332: Line 308:
Don't worry. There is a new update ready. You do not need to do anything about this; the Warrior will update its code every hour. If you are impatient, please reboot the warrior and it will download the latest code and resume work.
Don't worry. There is a new update ready. You do not need to do anything about this; the Warrior will update its code every hour. If you are impatient, please reboot the warrior and it will download the latest code and resume work.


=== I'm running the scripts manually and I see a message about code being out of date. ===
=== I'm running a project manually and I see a message about code being out of date. ===


This happens when a bug in the scripts is discovered. Bugs are unavoidable, especially when the server is out of our control.
This happens when a bug in the scripts is discovered. Bugs are unavoidable, especially when the server is out of our control.
Line 349: Line 325:


=== The warrior is eating all my bandwidth! ===
=== The warrior is eating all my bandwidth! ===
==== Virtual machine ====


On VirtualBox (relatively recent versions), use this command:
On VirtualBox (relatively recent versions), use this command:


<pre>vboxmanage bandwidthctl archiveteam-warrior-3 add limit --type network --limit 3m</pre>
<pre>VBoxManage bandwidthctl archiveteam-warrior-3.2 add limit --type network --limit 3m</pre>


This will limit the warrior to 3Mb/s. (Limit units are <code>k</code> for kilobit, <code>m</code> for megabit, <code>g</code> for gigabit, <code>K</code> for kilobyte, <code>M</code> for megabyte, and <code>G</code> for gigabyte.)  Adjust as required. :)
This will limit the warrior to 3Mb/s. (Limit units are <code>k</code> for kilobit, <code>m</code> for megabit, <code>g</code> for gigabit, <code>K</code> for kilobyte, <code>M</code> for megabyte, and <code>G</code> for gigabyte.)  Adjust as required. :)
Line 358: Line 336:
In the latest version of VirtualBox on Windows, the syntax appears to have changed. The correct command now seems to be:
In the latest version of VirtualBox on Windows, the syntax appears to have changed. The correct command now seems to be:


<pre>VBoxManage bandwidthctl archiveteam-warrior-3 add netlimit --type network --limit 3</pre>
<pre>VBoxManage bandwidthctl archiveteam-warrior-3.2 add netlimit --type network --limit 3</pre>


For more information, consult [http://www.virtualbox.org/manual/ch06.html#network_bandwidth_limit the VirtualBox manual (Chapter 6, Section 9)].
For more information, consult [http://www.virtualbox.org/manual/ch06.html#network_bandwidth_limit the VirtualBox manual (Chapter 6, Section 9)].


On VMWare (versions 9 and above), select a virtual machine and open Settings Hardware Virtual Network Adapter Advanced. You can set a bandwidth limit here.
On VMWare (versions 9 and above), select a virtual machine and open <code>Settings > Hardware > Virtual Network Adapter > Advanced</code>. You can set a bandwidth limit here.
 
==== Docker container ====


Docker has no feature for limiting bandwidth.
You're out of luck; Docker has no feature for limiting bandwidth.


=== The Warrior virtual machine is using up disk space, even though it's not running a project! ===
=== The Warrior virtual machine is using up disk space, even though it's not running a project! ===


Virtual machine disk images do not behave like a regular file. There are several ways to safely reclaim space:
Virtual machine disk images do not behave like a regular file. There are several ways to safely reclaim space:
<!--
 
* Delete the second disk and put back an empty disk. The warrior should reformat the second disk. -->
* Delete the entire warrior application and re-import it.
* Delete the entire warrior application and re-import it.
* Use the VirtualBox CLI to compact the disk. First, shut down the VM. Then, open a terminal and navigate to the folder where the hard-disk VDI file is stored. Finally, run <code>VBoxManage modifymedium --compact archiveteam-warrior-v3.2-20210306-disk001.vdi</code>, replacing <code>archiveteam-warrior-v3.2-20210306-disk001.vdi</code> with the name of the VDI file in use by the Warrior VM. See the [https://www.virtualbox.org/manual/ch08.html#vboxmanage-modifymedium VirtualBox documentation] for more details and additional steps to help achieve a better result.
* Use the VirtualBox CLI to compact the disk. First, shut down the VM. Then, open a terminal and navigate to the folder where the hard-disk VDI file is stored. Finally, run <code>VBoxManage modifymedium --compact archiveteam-warrior-v3.2-20210306-disk001.vdi</code>, replacing <code>archiveteam-warrior-v3.2-20210306-disk001.vdi</code> with the name of the VDI file in use by the Warrior VM. See the [https://www.virtualbox.org/manual/ch08.html#vboxmanage-modifymedium VirtualBox documentation] for more details and additional steps to help achieve a better result.
Line 377: Line 356:
This issue should not affect Docker containers.
This issue should not affect Docker containers.


=== Recovering from a ungraceful virtual machine/Docker container stop ===
=== My Warrior crashed, or I had to hard-stop it, and I don't think there's time to retry the tasks. ===
 
Please notify us in the project [[Archiveteam:IRC|IRC]] channel, including for stops due to system failures and power outages as well as hard-kills. Do not attempt to start or restart the affected containers. If time is indeed a concern, we can help you save or recover partial data from your Warrior.


Please ask in the project [[Archiveteam:IRC|IRC]] channel if some of your VMs or containers were stopped ungracefully. This includes using a container stop that used a hard-kill, also stops due to system failures or power outages. This is especially important for projects where there may not be enough time for another worker to retry later. Do not attempt to start/restart the affected containers. (Note: it is possible to recover/save partial WARCs using <code>docker cp archiveteam:/grab/ ./</code> or similar from still running containers that are about to be terminated.)
(The same applies if your Warrior is still running, but tasks are now stuck—especially if they're stuck because the project has reached its deadline and the target site is now gone. Most projects should handle this gracefully, but contact us if they do not.)


=== The item I'm working on is downloading thousands of URLs and it's taking hours. ===
=== The item I'm working on is downloading thousands of URLs and it's taking hours. ===

Revision as of 20:10, 7 April 2021

Archiveteam1.png The current versions of the Warrior Docker image and the Warrior virtual machine image should now be compatible with most projects; however some projects may still not be compatible and show a blank screen when attempting to run them. As an alternative, you can run individual projects manually using Docker.

If you have any issues or feedback, see the AT #warrior IRC channel on hackint.

What is the Archive Team Warrior?

Archive team.png
Warrior-vm-screenshot.png
Warrior-web-screenshot.png

The Archive Team Warrior is a virtual archiving appliance. You can run it to help with the Archive Team archiving efforts. It will download sites and upload them to our archive—and it’s really easy to do!

The warrior is a container running inside a virtual machine, so there is no risk to your computer. The warrior will only use your bandwidth and some of your disk space. It will get tasks from and report progress to the Tracker.

Basic usage

The Warrior runs on Windows, macOS, and Linux. You can run it using a virtual machine (simplest) or using Docker (slightly more complicated, but much less overhead than the VM).

Installing and running with a virtual machine

You'll need:

VirtualBox

  1. Download the appliance from the link above.
  2. Launch VirtualBox.
  3. In VirtualBox, click File > Import Appliance and open the file.
  4. Start the virtual machine.
    • It will fetch the latest updates and will eventually tell you to start your web browser.
  5. Using your regular web browser, visit http://localhost:8001/.

A video demonstrating these steps is available. (Note that the screen indicating that the Warrior has finished loading looks different than the one from when this video was made, but the steps are otherwise the same.)

VMWare Player

Note that VMWare Player may have some compatibility issues with running the Warrior image.

  1. Download the appliance from the link above.
  2. Launch VMWare Player.
  3. In Player on the right, click "Open Virtual Machine", open the file and import the virtual machine.
  4. (Optional) Select the virtual machine and click "Edit virtual machine settings".
    • Select Network Adapter and set it to "Bridged: Connected directly to the physical network"
  5. Start the virtual machine.
    • It will fetch the latest updates and will eventually tell you to start your web browser.
  6. Using your regular web browser, visit the address that is shown on the bottom (e.g. http://192.168.0.100:8001/)

Installing and running with Docker

You'll need Docker (open source) and the Warrior Docker image.

  1. Download Docker from the link above and install it.
  2. Open your terminal. On Windows, you can use either Command Prompt (CMD) or PowerShell. On macOS and Linux you can use Terminal (Bash).
  3. Use the following command to start the Warrior as well as Watchtower, which will automatically keep your Warrior updated:
    docker run --detach --name watchtower --restart=unless-stopped --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=unless-stopped --publish 8001:8001 atdr.meo.ws/archiveteam/warrior-dockerfile
    (For a full explanation of this command, see items 3 and 4 here.)
  4. Using your regular web browser, visit http://localhost:8001/.


Warrior FAQ

Why a virtual machine/container in the first place?

The Warrior is a quick, safe, and easy way for newcomers to help us out. It offers many features:

  • Graphical interface (virtual machine only)
  • Automatically selects which project is important to run
  • Self-updating software infrastructure
  • Allows for unattended use
  • In case of software faults, your machine is not ruined
  • Restarts itself in case of runaway programs
  • Runs on Windows, Mac, and Linux painlessly
  • Ensures consistency in the archived data regardless of your machine's quirks
  • Can be configured to restart automatically after a system restart (see below).

If you have suggestions for improving this system, talk to us.

Can I use whatever internet access for the Warrior?

No. We need "clean" connections. Please ensure the following:

  • No OpenDNS. No ISP DNS that redirects to a search page. Use non-captive DNS servers.
  • No ISP connections that inject advertisements into web pages.
  • No proxies. Proxies can return bad data. The original HTTP headers and IP address are needed for the WARC file.
  • No content-filtering firewalls.
  • No censorship. If you believe your country implements censorship, do not run a warrior.
  • No Tor. The server may return an error page instead of content if they ban exit nodes.
  • No free cafe wifi. Archiving your cafe's wifi service agreement repeatedly is not helpful.
  • No VPNs. Data integrity is a very high priority for the Archive Team so use of VPNs with the official crawler is discouraged.
  • We prefer connections from many public IP addresses if possible. (For example, if your apartment building uses a single IP address, we don't want your apartment banned.)

I turned my Warrior off. Will those tasks be lost?

If you've killed your Warrior, then the work it was doing has been lost. However, the tasks will be returned to the pool after a period of time, and other warriors may claim them.

I closed my browser or tab with the Warrior's web interface. Will those tasks be lost?

No. The web browser interface just provides a user interface to the Warrior. As long as the VM or Docker container is not stopped, it will continue normally.

How can I shut down the Warrior without losing work?

Recommended method

Click the "Shut down" button on the left of the web interface. All the current tasks will still finish, but no new ones will be started. When a banner appears saying "There is no connection with the warrior", the Warrior has finished shutting down. (If you would rather use the command line than the web interface, see below).

Suspend/resume with the virtual machine

If you don't want to wait (perhaps because a task is long-running), you can use VirtualBox's Machine > Pause or VMWare's VM > Pause to suspend the Warrior VM, then resume it when you are ready to work again. Note that if you keep it suspended for too long (more than a few hours), the tracker will assume that the item is lost and re-queue it—but suspending in order to reboot your computer or reset your internet connection should be perfectly fine.

Suspend/resume with the Docker container

If you don't want to wait, you're out of luck; Docker does not have a feature for suspending containers.

How much disk space will the Warrior use?

Short answer: it depends on the project. The virtual machine has a hard limit of 60GB disk usage, but the Docker container does not have such a limit. However, it is highly unlikely that any project would use more than 60GB of disk space at any time.

Long answer: because each project defines items differently, sizes may vary. A single task may be a small file or a whole subsection of a website. The virtual machine is configured by default to use an absolute maximum of 60GB, but Docker has no hard limit. Any unused virtual machine or Docker container disk space is not used on the host computer. You may configure the virtual machine to run on less than 60GB if you like to live dangerously. We're downloading the internet, after all!

How can I log into the Warrior?

Unless you know what you are doing, you should not need to do this.

Virtual machine

With the Warrior running, press ALT+F4 to switch to virtual console number 4. VirtualBox users may need to press the host key, RIGHT_CONTROL, to enter capture mode before pressing ALT+F4. Use ALT+Left or ALT+Right to switch between virtual consoles. There are 6 virtual consoles in total. Consoles 1, 2, and 3 are reserved for the warrior. Switching to a new virtual console will show a login shell. You can login using the username root and the password archiveteam.

Docker container

With the Warrior running, open your terminal and run sudo docker exec -t -i archiveteam-warrior /bin/bash. Replace 'archiveteam-warrior' with the name of your Warrior container if necessary.

How can I run multiple Warriors at the same time?

This usually isn't necessary; if you want to increase your work on a project, you can increase the number of items your Warrior will work on at the same time. In the web interface, go to the "Your settings" tab, tick the "Show advanced settings" box, and edit the "Concurrent items" field. The maximum concurrency is 6.

Virtual machines

You'll need to adjust the networking settings.

In VirtualBox, select a virtual machine and open up Settings > Network > Adapter 1 > Port Forwarding. You need to adjust the host port. For example, setting your table to TCP | 127.0.0.1 | 8123 | | 8001 will map port 8123 on the host machine (your computer) to port 8001 on the virtual machine (the warrior), and you can then access the warrior's web interface from port 8123 in your browser.

VMWare installations should be using bridged networking. However, if you want, you can switch to NAT (under Settings > Hardware > Virtual Network Adapter) and click Edit to set up port forwarding. On Linux, you can also use lines like 8123 = 192.168.0.100:8001 in the [incomingtcp] section of nat.conf. (Make sure the VM IP is correct!)

Each VM you want to access should have a different host port. Do not use port numbers below 1024 unless you know what you are doing.

Docker containers

You'll need to adjust the run command used to create the containers.

First, each container needs a unique name, so you will need to replace the name specified with the --name parameter with something unique.

Second, you will need to specify a unique port to access the web interface of each container. You can do this by changing the number before the : in the --publish parameter to any available unique port number equal to or greater than 1024. (Additional options for specifying ports are explained in the Docker documentation.)

You may also want to reuse your configuration between different Docker containers; you can do this by specifying the same environment variables or bindmounting the same config.json file across all of your containers. See the Warrior Dockerfile README for more details about this.

How can I run the Warrior headlessly (without leaving a window open)?

Virtual machine

From the VirtualBox GUI, after opening the VM, click Machine > Detach GUI. You can then close the VirtualBox Manager window.

For the VirtualBox CLI, you can start up the VM with VBoxManage startvm archiveteam-warrior-3.2 --type headless and shut it down with VBoxManage controlvm archiveteam-warrior-3.2 acpipowerbutton. Substituting suspend or resume for acpipowerbutton suspends or resumes the VM. For more information, consult the VirtualBox manual (Chapter 8, Sections 12 and 13).

For the VMWare CLI, you can start up the VM with vmrun start <path to vmx file> nogui and shut it down with vmrun stop <path to vmx file> soft. Substituting suspend for stop suspends the VM; resume with start again. For more information, including the paths to VMX files on different operating systems, consult Using vmrun to Control Virtual Machines (PDF), pages 10 and 11.

Docker container

The container does not have a GUI, and if run with --detach (as the instructions suggest), it will not occupy your terminal window either. It is therefore headless by default. You can start up the container with docker start archiveteam-warrior and shut it down with docker kill --signal=SIGINT archiveteam-warrior.

How can I set up the Warrior to start up on boot and shut down automatically?

Virtual machine

If you are using VirtualBox and running a Linux distribution that uses the systemd init system (like most recent releases), you can set the VM up as a system service by following the short instructions on this page. (The page title specifies Arch Linux, but this will work for other distros as long as they run systemd.)

Docker container

If the container is run with --restart=unless-stopped (as the instructions suggest), Docker will automatically start it on boot.

How can I set up the virtual machine with directly-bridged networking instead of NAT?

On VirtualBox, use these commands:

VBoxManage modifyvm archiveteam-warrior-3.2 --nic1 bridged
VBoxManage modifyvm archiveteam-warrior-3.2 --bridgeadapter1 eth0

We presume you want to bind to eth0. Adjust as required. :)

VMWare installations should already be using bridged networking.

How can I access the virtual machine from another device on my network?

Full guide for VirtualBox users is found here.

What's new in version 3.2 of the Warrior virtual machine?

This update enables running newer projects, shortens startup times, enables viewing basic logs from the virtual machine console (press ALT+F2 for Warrior logs, press ALT+F3 for automatic updater logs, and press ALT+F1 to return to the splash screen), and has other minor improvements. Warriors versions 3.0 and 3.1 will automatically update themselves with the project compatibility improvements, but the other improvements require re-creating the VM with version 3.2 of the appliance.

Are previous versions of the Warrior still supported?

Virtual machine

Currently, versions 3.0, 3.1, and 3.2 of the Warrior virtual machine are functional and supported, and are capable of automatically retrieving updated components as needed. Support for version 2 and prior of the Warrior virtual machine was discontinued around 2018 due to outdated SSL support.

Docker container

We always recommend using the latest version of the Warrior Docker image, as new and updated projects often require the updated components provided by newer Docker images. If you run the Docker container with Watchtower (as the instructions suggest), your Docker container will automatically be kept up-to-date.

How can I run tons of Warriors easily?

We assume you've checked with the current Archive Team project leads what concurrency and resources are needed or useful!

Whether your have your own virtual cluster or you're renting someone else's (aka a "cloud"), you probably need some orchestration software.

Archive Team volunteers have successfully used a variety of hosting providers and tools (including free trials on AWS and GCE), often just by building their own flavor of virtual server and then repeating it with simple cloud-init scripts or whatever tool the hosting provides. If you desire full automation, the archiveteam-infra repository by diggan helps with Terraform on DigitalOcean.

Some custom monitoring scripts also exist, for instance watcher.py.

The instructions for running multiple Warriors on one machine may be helpful. However, you should also consider running Docker containers for individual projects rather than the Warrior; these have even less overhead and can be configured with greater concurrency.

What are the alternatives to using the Warrior?

One is running Docker containers for individual projects. This is particularly useful if you want to deploy a large amount of computing power.

Another is running individual projects directly. Check the source repository for the project you're interested in and follow the instructions for running without a Warrior in the README. This is particularly useful if you want to deploy on a machine where you don't have root.

We generally recommend that people use the Warrior, because it is simple for non-technical users to set up and it requires no supervision. You should only use these alternatives if you are comfortable with Linux and prepared to manually intervene when projects begin and end.

I'm looking at the leaderboard. What's that icon beside the username?

That's just the warrior logo: Archive team.png (click on the image for a larger version). It means that that person is using the warrior. Those without the icon are running the project manually.

Archiveteam-warrior-sticker.png

What's that guy doing in the logo?

The place is on fire! But don't worry, he safely escaped with the rescued data in his arms.

That’s awesome—can I slap this logo on my laptop to show my Internet-preservation pride?

You sure can! The ArchiveTeam Warrior laptop sticker can start conversations about archiving, if you’re into that.

I'd like to help write code or I want to tweak the scripts to run to my liking. Where can I find more info? Where is the source code and repository?

In order to ensure data accuracy, it is imperative that users contributing to Archive Team projects do not modify the project scripts. If you would like to propose improvements to be included in future official versions of/updates to project scripts or would like to use our code for non-Archive Team projects, check out the Dev documentation for details on the infrastructure and details of the source code layout.

I still have a question!

Check out the general FAQ page. Talk to us on IRC. Use #warrior for specific warrior questions or #archiveteam-bs for general questions.

Troubleshooting

I'm getting errors when I try to launch the VM.

If you are receiving Breakpoint has been reached (0x80000003), A critical error has occurred while running the virtual machine and the machine execution has been stopped., or VT-X errors, you probably do not have virtualization enabled, either because it is turned off in your computer's BIOS or your CPU does not support it.

You can check CPU support on Linux with cat /proc/cpuinfo | grep "(vmx|svm)" | uniq. If there is a line of output starting with "flags", your processor supports virtualization; if there is no output, it does not. You can check whether virtualization is enabled in the BIOS using the rdmsr utility in your distro's msr-tools package.

You can check support and BIOS status on Windows using Microsoft's Hardware-Assisted Virtualization Detection Tool or VirtualChecker.

To enable virtualization on a CPU with support, reboot the computer and enter the BIOS. The virtualization setting is usually under something like 'CPU configuration' or 'advanced settings'.

I can't connect to localhost.

Virtual machine

The application is configured to set up port forwarding to the guest machine, and you should be able to access the interface through your web browser at port 8001. If this does not happen, and isn't resolved by rebooting the warrior (using the ACPI power signals, not suspend/save state and resume), you may need to double-check your machine's network settings (as described above).

Docker container

Make sure you invoked docker run with the option --publish. To access the web interface at http://localhost:X/, you must use --publish X:8001.

The warrior can't connect to the internet.

It's possible that the virtual machine has picked up the address of the local DNS cache on your computer, which the virtual machine does not have access to.

If you experience this on VirtualBox, see this question and answer. Additionally, check to see if "Cable Connected" is unchecked in the advanced settings of the virtual adapter, under the network tab in the virtual machine's settings. Check it if it's unchecked, then save your settings.

I see a message that no item was received.

This means that there is no work available. This can happen for several reasons:

  • The project has just finished and someone is inspecting the work done. If a problem is discovered, items may be re-queued and more work will become available.
  • You have checked out/claimed too many items. Reduce your concurrency and let others do some of the work too.
  • In a rare case, you have been banned by a tracker administrator because there was a problem with your work: you were requesting too much, you were tampering with the scripts, a malfunction has occurred, or your internet connection is "unclean" (see above).

I see a message about rate limiting.

Don't worry. Keep in mind that although downloading the internet for fun and digital preservation are the primary goals of all Archive Team activities, serious stress on the target's server may occur. The rate limit is imposed by a tracker administrator and should not be subverted.

(In other words, we don't want to DDoS the servers.)

If you like, you can switch to another project with less load.

I see a message about code being out of date.

Don't worry. There is a new update ready. You do not need to do anything about this; the Warrior will update its code every hour. If you are impatient, please reboot the warrior and it will download the latest code and resume work.

I'm running a project manually and I see a message about code being out of date.

This happens when a bug in the scripts is discovered. Bugs are unavoidable, especially when the server is out of our control.

If you are running the scripts using Docker, we recommend using Watchtower to check for updates every hour, downloading and installing them when necessary. See the setup instructions in Running Archive Team Projects with Docker for more details.

If you are not running the scripts using the provided Docker images, try the --auto-update option available in Seesaw version 0.8. However, please be aware that you are now executing code automatically. Be sure to run the scripts in a separate user account for safety.

I see messages about rsync errors.

Uh-oh! Something is not right. Please notify us immediately in the appropriate IRC channel.

I told the warrior to shut down from the interface, but nothing has changed.

The warrior will attempt to finish the current running tasks before shutting down. If you need to shut down right away, go ahead. Your progress will be lost, but the jobs will eventually cycle out to another user.

The warrior is eating all my bandwidth!

Virtual machine

On VirtualBox (relatively recent versions), use this command:

VBoxManage bandwidthctl archiveteam-warrior-3.2 add limit --type network --limit 3m

This will limit the warrior to 3Mb/s. (Limit units are k for kilobit, m for megabit, g for gigabit, K for kilobyte, M for megabyte, and G for gigabyte.) Adjust as required. :)

In the latest version of VirtualBox on Windows, the syntax appears to have changed. The correct command now seems to be:

VBoxManage bandwidthctl archiveteam-warrior-3.2 add netlimit --type network --limit 3

For more information, consult the VirtualBox manual (Chapter 6, Section 9).

On VMWare (versions 9 and above), select a virtual machine and open Settings > Hardware > Virtual Network Adapter > Advanced. You can set a bandwidth limit here.

Docker container

You're out of luck; Docker has no feature for limiting bandwidth.

The Warrior virtual machine is using up disk space, even though it's not running a project!

Virtual machine disk images do not behave like a regular file. There are several ways to safely reclaim space:

  • Delete the entire warrior application and re-import it.
  • Use the VirtualBox CLI to compact the disk. First, shut down the VM. Then, open a terminal and navigate to the folder where the hard-disk VDI file is stored. Finally, run VBoxManage modifymedium --compact archiveteam-warrior-v3.2-20210306-disk001.vdi, replacing archiveteam-warrior-v3.2-20210306-disk001.vdi with the name of the VDI file in use by the Warrior VM. See the VirtualBox documentation for more details and additional steps to help achieve a better result.
  • Use the zerofree program and then clone the disk image. Reattach the cloned disk image.

This issue should not affect Docker containers.

My Warrior crashed, or I had to hard-stop it, and I don't think there's time to retry the tasks.

Please notify us in the project IRC channel, including for stops due to system failures and power outages as well as hard-kills. Do not attempt to start or restart the affected containers. If time is indeed a concern, we can help you save or recover partial data from your Warrior.

(The same applies if your Warrior is still running, but tasks are now stuck—especially if they're stuck because the project has reached its deadline and the target site is now gone. Most projects should handle this gracefully, but contact us if they do not.)

The item I'm working on is downloading thousands of URLs and it's taking hours.

Please notify us in the appropriate IRC channel. You may need to reboot the Warrior.

Why is the default project not working? / Why is a manual project not in the Warrior yet?

Sorry. Sometimes the administrators are too busy...

Why are there no projects?

We finished the ones we were working on! If there are no projects showing, you can help us write one. No projects does not mean there is nothing left to archive!

The instructions to run the software/scripts are awful and they are difficult to set up.

Well, excuuuuse me, princess!

We're not a professional support team so help us help you help us all. See above for bug reports, suggestions, or code contributions.

Where can I file a bug, suggestion, or a feature request?

If the issue is related to the warrior's web interface or the library that grab scripts are using, see seesaw-kit issues. Other issues should be filed into their own repositories.

Projects

See Warrior projects.

Are you a coder?

Like the Warrior? Interested in how it works under the hood? Got software skills? Help us improve it!