No description
Find a file
Andrew Davidson 402d7208d7
Fixes #3, Updating gitignore and readme.md to reflect new config stucture and
ignore archivist.yml in local folder to avoid committing secrets
2020-04-05 15:55:39 -04:00
archivist Github working with new config structure, working #3 2020-04-05 15:50:50 -04:00
bin Adding a shell script to allow running via pipenv in an alternate folder 2020-04-03 15:21:29 -04:00
.gitignore Fixes #3, Updating gitignore and readme.md to reflect new config stucture and 2020-04-05 15:55:39 -04:00
archivist.py Updating folder structure and running from a central script. 2020-03-31 15:36:36 -04:00
Pipfile Working version of imap backup. 2020-04-02 16:29:52 -04:00
Pipfile.lock Working version of imap backup. 2020-04-02 16:29:52 -04:00
readme.md Fixes #3, Updating gitignore and readme.md to reflect new config stucture and 2020-04-05 15:55:39 -04:00

Archivist

The archivist is run from a either a central archivist.py script

Running ./archivist.py alone will back up all configured services.

You can also back up a single service by running ./archivist.py backup service

Configuring the Archivist

The Archivist is configured with a yaml file at ~/.archivist.yml

Example:

services:
    github:
        name: "Github"
        service_type: github
        backup_folder: /home/user/backups/github
        user: gh-user 
    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

Supported Services

  • Github
  • Pinboard
  • IMAP servers

Service Notes

Github

The Archivist only supports backups of a users public repositories and gists at this time. See #2.

IMAP Servers

The Archivist is currently tested against Fastmail, other IMAP servers may present issues. Report an issue with any problesm you see.