Fixes #3, Updating gitignore and readme.md to reflect new config stucture and
ignore archivist.yml in local folder to avoid committing secrets
This commit is contained in:
parent
88152f6fee
commit
402d7208d7
2 changed files with 23 additions and 15 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1,2 +1,4 @@
|
|||
__pycache__
|
||||
*.pyc
|
||||
archivist.yml
|
||||
|
||||
|
|
36
readme.md
36
readme.md
|
@ -13,21 +13,27 @@ The Archivist is configured with a `yaml` file at `~/.archivist.yml`
|
|||
|
||||
Example:
|
||||
```yaml
|
||||
backup_folder: /home/amd/backups
|
||||
|
||||
github_enabled: True
|
||||
github_user: defunkt
|
||||
|
||||
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
|
||||
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
|
||||
|
|
Loading…
Reference in a new issue