2.7 KiB
Installation
:maxdepth: 1
upgrading.md
There are 3 main ways to use the auto-archiver. We recommend the 'docker' method for most uses. This installs all the requirements in one command.
- Easiest (recommended): via docker
- Local Install: using pip
- Developer Install: see the developer guidelines
1. Installing with Docker
Docker works like a virtual machine running inside your computer, making installation simple. You'll need to first set up Docker, and then download the Auto Archiver 'image':
a) Download and install docker
Go to the Docker website and download right version for your operating system.
b) Pull the Auto Archiver docker image
Open your command line terminal, and copy-paste / type:
docker pull bellingcat/auto-archiver
This will download the docker image, which may take a while.
That's it, all done! You're now ready to set up your configuration file. Or, if you want to use the recommended defaults, then you can run Auto Archiver immediately.
2. Installing Locally with Pip
- Make sure you have python 3.10 or higher installed
- Install the package with your preferred package manager:
pip/pipenv/conda install auto-archiverorpoetry add auto-archiver - Test it's installed with
auto-archiver --help - Install other local dependency requirements (for example
ffmpeg,firefox)
After this, you're ready to set up your your configuration file, or if you want to use the recommended defaults, then you can run Auto Archiver immediately.
Installing Local Requirements
If using the local installation method, you will also need to install the following dependencies locally:
1.ffmpeg - for handling of downloaded videos
2. firefox and geckodriver on a path folder like /usr/local/bin - for taking webpage screenshots with the screenshot enricher
3. (optional) fonts-noto to deal with multiple unicode characters during selenium/geckodriver's screenshots: sudo apt install fonts-noto -y.
4. Browsertrix Crawler docker image for the WACZ enricher/archiver