diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -1,15 +1,15 @@ # Orange Whale -Orange whale is a backup software that usage telegram as free storge. A docker image is available, just mount +Orange whale is a backup software that uses telegram as free storge. A docker image is available, just mount the folders you want to backup and pass the folder names to `LOCATIONS` to tell Orange Whale what to upload. It requires you to also mount `/app/pub.txt`, a file containing your public PGP key. Yes it is required, and yes -it is useful, don't upload your personal data on external services without encrypting them. +it is useful. DO NOT upload your personal data on external services without encrypting them. Now the following envvar: -- `TELOXIDE_TOKEN`: is the telegram bot token you'll be using +- `TELOXIDE_TOKEN`: is the token of the telegram bot you'll be using - `CHAT_ID`: the group/channel your bot will upload to - `LOCATIONS`: the folders to upload -- `INTERVAL`: how often to upload in hours. It takes an integer -- `RUST_LOG`: for logging stuff. If you're using it with docker I advise you to set it to `info` +- `INTERVAL`: an integer indicating how often to backup specified in hours +- `RUST_LOG`: logging verbosity. If you're using docker I advise you to set it to `info` ## Backups Once the bot starts uploading you'll realize that the data is split in multiple parts. That's because bots on |