Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kanewi11/db-telegram-backup
Backup MySQL, MariaDB or PostgreSQL databases from Docker to Telegram chat
https://github.com/kanewi11/db-telegram-backup
backup mariadb mysql postgresql
Last synced: 9 days ago
JSON representation
Backup MySQL, MariaDB or PostgreSQL databases from Docker to Telegram chat
- Host: GitHub
- URL: https://github.com/kanewi11/db-telegram-backup
- Owner: kanewi11
- Created: 2024-11-22T10:38:37.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T14:28:06.000Z (3 months ago)
- Last Synced: 2024-12-01T21:11:41.278Z (2 months ago)
- Topics: backup, mariadb, mysql, postgresql
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DB Telegram Backup
A Python-based solution to backup data via Telegram with an easy setup process and periodic task scheduling using `crontab`.
# Supported databases
- `PostgreSQL`
- `MySQL`
- `MariaDB`
## Installation
Follow the steps below to install the project:
1. Navigate to the `/opt` directory:
```bash
cd /opt
```
2. Clone the repository:
```bash
sudo git clone https://github.com/kanewi11/db-telegram-backup.git
```
3. Enter the project directory:
```bash
cd /opt/db-telegram-backup
```
4. Update the package list and install Python pip:
```bash
sudo apt-get update -y && sudo apt-get install python3-pip -y
```
5. Install Poetry (Python dependency manager):
```bash
curl -sSL https://install.python-poetry.org | python3 -
```
6. Add Poetry to the system path:
```bash
export PATH="$HOME/.local/bin:$PATH"
```
7. Configure Poetry to use project-local virtual environments:
```bash
sudo poetry config virtualenvs.in-project true
```
8. Install the project dependencies using Poetry:
```bash
sudo poetry install
```
## Setting Up Before Starting
Prepare the environment and perform a functional check:
1. Navigate to the project directory:
```bash
cd /opt/db-telegram-backup
```
2. Create a `.env` file from the example template:
```bash
sudo cp .envs/.env.example .envs/.env
```
3. Open the `.env` file for editing:
```bash
sudo nano .envs/.env
```
4. Activate the virtual environment:
```bash
sudo poetry shell
```
5. Run the main script to verify functionality:
```bash
sudo python main.py
```
## Automating with Crontab
Set up a cron job to automate the backup process:
1. Open the crontab editor:
```bash
sudo crontab -e
```
2. Add the following line to schedule the script to run hourly:
```
0 * * * * cd /opt/db-telegram-backup/ && .venv/bin/python main.py
```
This runs the script at the start of every hour.
## Contributing
Feel free to contribute by submitting issues or pull requests to the GitHub repository. I won't answer or respond to them anyway :)