The archivist is run from a either a script or a Docker container.
Running bin/archivist.sh alone will back up all configured services.
You can also back up a single service by running bin/archivist.sh backup service
The docker container needs two volumes, one mounted wherever you store the backups and
the other at /archivist/archivist.yml for the config file.
Example:
docker run --rm \
-v /home/host-user/host_backup_dir:/backups \
-v /home/host-user/archivist_config.yml:/archivist/archivist.yml \
amdavidson/archivistThe Archivist is configured with a yaml file stored at one of these locations:
./archivist.yml$XDG_CONFIG_HOME/archivist/archivist.yml~/.config/archivist/archivist.yml~/.archivist.yml/etc/archivist/archivist.yml
Example:
services:
github:
name: "Github"
service_type: github
backup_folder: /home/user/backups/github
user: gh-user
token: 0xDEADBEEF
disable_repos: False
disable_gists: False
repo_backup_list:
- important-repository
gist_backup_list:
- 1337
pinboard:
name: "Pinboard"
service_type: pinboard
backup_folder: /home/user/backups/pinboard
user: pbuser
token: 0xDEADBEEF
fastmail:
name: "Email Host"
service_type: imap
backup_folder: /home/user/backups/fastmail
server: imap.email.host.name
user: user@email.host.name
password: Hunter2
cleanup: False
compress: True
carddav:
service_type: carddav
name: "Email Host Carddav"
backup_folder: /home/user/backups/contacts
url: carddav.email.host.name
user: user@email.host.name
password: Hunter2
cleanup: False
caldav:
service_type: caldav
name: "Email Host Carddav"
backup_folder: /home/user/backups/caldav
url: caldav.email.host.name
user: user@email.host.name
password: Hunter2
cleanup: False- Github
- Pinboard
- IMAP servers
- CardDav servers
- CalDav servers
The Archivist is currently tested against Fastmail and iCloud, other hosts may present issues. Report an issue with any problems you see.