https://github.com/mroik/orange-whale
A backup software that uses telegram as its storage
https://github.com/mroik/orange-whale
backup telegram
Last synced: 2 months ago
JSON representation
A backup software that uses telegram as its storage
- Host: GitHub
- URL: https://github.com/mroik/orange-whale
- Owner: Mroik
- License: mit
- Created: 2025-06-24T06:24:29.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2026-03-01T15:16:34.000Z (4 months ago)
- Last Synced: 2026-03-01T18:29:21.931Z (4 months ago)
- Topics: backup, telegram
- Language: Rust
- Homepage:
- Size: 107 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Orange Whale
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. DO NOT upload your personal data on external services without encrypting them.
Now the following envvar:
- `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`: 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
telegram have an upload limit of 50MB on files. Just download all the parts and `cat` them together. After that
you can decrypt using your PGP key and unpack using tar.
```sh
cat part_* | gpg -d | tar x
```