aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMroik <mroik@delayed.space>2025-06-24 18:35:47 +0200
committerMroik <mroik@delayed.space>2025-06-24 18:35:47 +0200
commit5358267771fc7eca23c28e890141666ad23512ed (patch)
tree85641ad54ca623223d289be0b45b9a7a7602a819 /README.md
parentd2ee0f07d3db0e707f16bbcb8abc3120dab10161 (diff)
Include empty directories
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 9af63c9..7ba9c88 100644
--- a/README.md
+++ b/README.md
@@ -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