gru/routeros_backup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
gru
2026-01-14 08:54:37 +01:00
parent 2cbe098292
commit 5ac954fa82
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -2,7 +2,7 @@
RouterOS Backup Manager to aplikacja Flask umożliwiająca zarządzanie kopiami zapasowymi urządzeń Mikrotik RouterOS. Aplikacja pozwala na eksport konfiguracji, tworzenie backupów binarnych, ich przechowywanie, porównywanie oraz przywracanie. RouterOS Backup Manager to aplikacja Flask umożliwiająca zarządzanie kopiami zapasowymi urządzeń Mikrotik RouterOS. Aplikacja pozwala na eksport konfiguracji, tworzenie backupów binarnych, ich przechowywanie, porównywanie oraz przywracanie.
## 🔧 Instalacja ## Instalacja
### 1. Klonowanie repozytorium ### 1. Klonowanie repozytorium
```sh ```sh
@@ -30,7 +30,7 @@ Aplikacja będzie dostępna pod adresem: `http://127.0.0.1:5581/`
--- ---
## 📦 Uruchamianie w Dockerze ## Uruchamianie w Dockerze
1. **Zbudowanie obrazu Docker** 1. **Zbudowanie obrazu Docker**
```sh ```sh
@@ -45,20 +45,20 @@ Aplikacja uruchomi się na porcie `5581`.
--- ---
## 📚 Funkcjonalności ## Funkcjonalności
- 🔐 System użytkowników (rejestracja, logowanie, zmiana hasła) - System użytkowników (rejestracja, logowanie, zmiana hasła)
- 📡 Połączenie SSH do routerów MikroTik - Połączenie SSH do routerów MikroTik
- 🛠 Eksport konfiguracji i tworzenie backupów binarnych - Eksport konfiguracji i tworzenie backupów binarnych
- 🕵️‍♂️ Porównywanie backupów (`diff`) - Porównywanie backupów (`diff`)
- 📩 Powiadomienia e-mail oraz Pushover - Powiadomienia e-mail oraz Pushover
- 📅 Harmonogram automatycznych backupów (APScheduler) - Harmonogram automatycznych backupów (APScheduler)
- 🧹 Automatyczne czyszczenie starych backupów i logów - Automatyczne czyszczenie starych backupów i logów
- 🚀 Obsługa przez interfejs webowy - Obsługa przez interfejs webowy
--- ---
## ⚙️ Konfiguracja ## Konfiguracja
### Zmiana ustawień ### Zmiana ustawień
Plik `app.py` zawiera konfigurację bazy danych oraz inne ustawienia aplikacji: Plik `app.py` zawiera konfigurację bazy danych oraz inne ustawienia aplikacji:
@@ -68,19 +68,19 @@ app.config['SECRET_KEY'] = 'super-secret-key'
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///backup_routeros.db' app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///backup_routeros.db'
``` ```
### 📬 Konfiguracja SMTP (E-mail) ### Konfiguracja SMTP (E-mail)
Aby skonfigurować powiadomienia e-mail, wprowadź dane w sekcji ustawień: Aby skonfigurować powiadomienia e-mail, wprowadź dane w sekcji ustawień:
- Serwer SMTP - Serwer SMTP
- Login/hasło SMTP - Login/hasło SMTP
- Port (587 dla TLS, 465 dla SSL) - Port (587 dla TLS, 465 dla SSL)
### 📲 Powiadomienia Pushover ### Powiadomienia Pushover
Aby włączyć powiadomienia Pushover, uzupełnij `pushover_token` oraz `pushover_userkey` w ustawieniach. Aby włączyć powiadomienia Pushover, uzupełnij `pushover_token` oraz `pushover_userkey` w ustawieniach.
--- ---
## 🔍 API & Health Check ## API & Health Check
Aplikacja zawiera endpoint `/health`, który zwraca status bazy danych: Aplikacja zawiera endpoint `/health`, który zwraca status bazy danych:
```sh ```sh
@@ -97,5 +97,5 @@ Przykładowa odpowiedź:
--- ---
## 🚀 Autor i licencja ## Autor i licencja
Projekt stworzony przez Mateusz Gruszczyński @linuxiarz.pl - dostępny na licencji MIT. Projekt stworzony przez Mateusz Gruszczyński @linuxiarz.pl - dostępny na licencji MIT.