2020-03-21 16:41:49 +00:00
|
|
|
# Archivist
|
2020-03-09 20:11:44 +00:00
|
|
|
|
2020-03-31 19:36:36 +00:00
|
|
|
The archivist is run from a either a central `archivist.py` script
|
2020-03-09 20:11:44 +00:00
|
|
|
|
2020-04-03 14:27:37 +00:00
|
|
|
Running `./archivist.py` alone will back up all configured services.
|
2020-03-21 16:41:49 +00:00
|
|
|
|
2020-04-03 14:27:37 +00:00
|
|
|
You can also back up a single service by running `./archivist.py backup service`
|
2020-03-21 16:41:49 +00:00
|
|
|
|
|
|
|
|
|
2020-04-03 14:27:37 +00:00
|
|
|
## Configuring the Archivist
|
2020-03-21 16:41:49 +00:00
|
|
|
|
2020-04-03 14:27:37 +00:00
|
|
|
The Archivist is configured with a `yaml` file at `~/.archivist.yml`
|
2020-03-21 16:41:49 +00:00
|
|
|
|
2020-04-03 14:27:37 +00:00
|
|
|
Example:
|
|
|
|
|
```yaml
|
|
|
|
|
backup_folder: /home/amd/backups
|
2020-03-21 16:41:49 +00:00
|
|
|
|
2020-04-03 14:27:37 +00:00
|
|
|
github_enabled: True
|
|
|
|
|
github_user: defunkt
|
2020-03-21 16:41:49 +00:00
|
|
|
|
2020-04-03 14:27:37 +00:00
|
|
|
pinboard_enabled: True
|
|
|
|
|
pinboard_user: idlewords
|
|
|
|
|
pinboard_token: 46a9d5bde718bf366178313019f04a753bad00685d38e3ec81c8628f35dfcb1b
|
|
|
|
|
|
|
|
|
|
imap_enabled: True
|
|
|
|
|
imap_localroot: maildir
|
|
|
|
|
imap_server: imap.email-host.com
|
|
|
|
|
imap_user: me@email-host.com
|
|
|
|
|
imap_password: hunter2
|
|
|
|
|
imap_cleanup: True
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Supported Services
|
|
|
|
|
|
|
|
|
|
- Github
|
|
|
|
|
- Pinboard
|
|
|
|
|
- IMAP servers
|
|
|
|
|
|
|
|
|
|
### Service Notes
|
|
|
|
|
|
|
|
|
|
#### Github
|
2020-04-03 14:30:41 +00:00
|
|
|
The Archivist only supports backups of a users public repositories and gists at this time. See [#2](https://github.com/amdavidson/archivist/issues/2).
|
2020-04-03 14:27:37 +00:00
|
|
|
|
|
|
|
|
#### IMAP Servers
|
|
|
|
|
The Archivist is currently tested against Fastmail, other IMAP servers may present issues. Report an issue with any problesm you see.
|
