3.6 KiB

Czysty Wina Historia

Installing Auto Archiver

:depth: 1
:hidden:

configurations.md
config_cheatsheet.md

There are 3 main ways to use the auto-archiver:

Easiest: via docker
Local Install: using pip
Developer Install: see the developer guidelines

But you always need a configuration/orchestration file, which is where you'll configure where/what/how to archive. Make sure you read orchestration.

Installing with Docker

Docker works like a virtual machine running inside your computer, it isolates everything and makes installation simple. Since it is an isolated environment when you need to pass it your orchestration file or get downloaded media out of docker you will need to connect folders on your machine with folders inside docker with the -v volume flag.

Install docker
Pull the auto-archiver docker image with docker pull bellingcat/auto-archiver
Run the docker image locally in a container: docker run --rm -v $PWD/secrets:/app/secrets -v $PWD/local_archive:/app/local_archive bellingcat/auto-archiver --config secrets/orchestration.yaml breaking this command down:
1. docker run tells docker to start a new container (an instance of the image)
2. --rm makes sure this container is removed after execution (less garbage locally)
3. -v $PWD/secrets:/app/secrets - your secrets folder
  1. -v is a volume flag which means a folder that you have on your computer will be connected to a folder inside the docker container
  2. $PWD/secrets points to a secrets/ folder in your current working directory (where your console points to), we use this folder as a best practice to hold all the secrets/tokens/passwords/... you use
  3. /app/secrets points to the path the docker container where this image can be found
4. -v $PWD/local_archive:/app/local_archive - (optional) if you use local_storage
  1. -v same as above, this is a volume instruction
  2. $PWD/local_archive is a folder local_archive/ in case you want to archive locally and have the files accessible outside docker
  3. /app/local_archive is a folder inside docker that you can reference in your orchestration.yml file

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-archiver or poetry add auto-archiver
Test it's installed with auto-archiver --help
Run it with your orchestration file and pass any flags you want in the command line auto-archiver --config secrets/orchestration.yaml if your orchestration file is inside a secrets/, which we advise

Installing Local Requirements

If using the local installation method, you will also need to install the following dependencies locally:

ffmpeg must also be installed locally for this tool to work.
firefox and geckodriver on a path folder like /usr/local/bin.
(optional) fonts-noto to deal with multiple unicode characters during selenium/geckodriver's screenshots: sudo apt install fonts-noto -y.

Developer Install

See the developer guidelines

3.6 KiB Czysty Wina Historia