Update README.md
This commit is contained in:
32
README.md
32
README.md
@@ -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.
|
||||
|
||||
## 🔧 Instalacja
|
||||
## Instalacja
|
||||
|
||||
### 1. Klonowanie repozytorium
|
||||
```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**
|
||||
```sh
|
||||
@@ -45,20 +45,20 @@ Aplikacja uruchomi się na porcie `5581`.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Funkcjonalności
|
||||
## Funkcjonalności
|
||||
|
||||
- 🔐 System użytkowników (rejestracja, logowanie, zmiana hasła)
|
||||
- 📡 Połączenie SSH do routerów MikroTik
|
||||
- 🛠 Eksport konfiguracji i tworzenie backupów binarnych
|
||||
- 🕵️♂️ Porównywanie backupów (`diff`)
|
||||
- 📩 Powiadomienia e-mail oraz Pushover
|
||||
- 📅 Harmonogram automatycznych backupów (APScheduler)
|
||||
- 🧹 Automatyczne czyszczenie starych backupów i logów
|
||||
- 🚀 Obsługa przez interfejs webowy
|
||||
- System użytkowników (rejestracja, logowanie, zmiana hasła)
|
||||
- Połączenie SSH do routerów MikroTik
|
||||
- Eksport konfiguracji i tworzenie backupów binarnych
|
||||
- Porównywanie backupów (`diff`)
|
||||
- Powiadomienia e-mail oraz Pushover
|
||||
- Harmonogram automatycznych backupów (APScheduler)
|
||||
- Automatyczne czyszczenie starych backupów i logów
|
||||
- Obsługa przez interfejs webowy
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Konfiguracja
|
||||
## Konfiguracja
|
||||
|
||||
### Zmiana ustawień
|
||||
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'
|
||||
```
|
||||
|
||||
### 📬 Konfiguracja SMTP (E-mail)
|
||||
### Konfiguracja SMTP (E-mail)
|
||||
Aby skonfigurować powiadomienia e-mail, wprowadź dane w sekcji ustawień:
|
||||
|
||||
- Serwer SMTP
|
||||
- Login/hasło SMTP
|
||||
- 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.
|
||||
|
||||
---
|
||||
|
||||
## 🔍 API & Health Check
|
||||
## API & Health Check
|
||||
Aplikacja zawiera endpoint `/health`, który zwraca status bazy danych:
|
||||
|
||||
```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.
|
||||
Reference in New Issue
Block a user