add readme file

2026-07-06 17:38:46 +02:00
parent 988e26e71d
commit e9655a8b00
1 changed files with 42 additions and 0 deletions
@@ -0,0 +1,42 @@
+# Automatyczna aktualizacja publicznego adresu IP
+
+Projekt stworzony z myślą o potrzebach homelabu — dzięki niemu nie jest wymagany
+stały adres zewnętrzny od dostawcy internetu. Wystarczy posiadać domenę
+(np. w OVH) i skorzystać z darmowej usługi DynDNS.
+
+## Jak to działa?
+
+Skrypt co minutę:
+1. Sprawdza aktualny publiczny adres IP
+2. Porównuje go z adresem zapisanym w rekordzie DNS
+3. Aktualizuje rekord, jeśli adresy się różnią
+
+## Spis treści
+
+- [1. Konfiguracja](#1-konfiguracja)
+  - [1.1 Plik konfiguracyjny](#1-skopiuj-env-default-do-env)
+  - [1.2 Spis zmiennych](#2-uzupelnij-env)
+- [2. Quick start](#2-quick-start)
+
+
+---
+
+## 1. Konfiguracja
+### 1. Skopiuj [.env-default](.env-default) do .env
+### 2. Uzupelnij [.env](.env)
+| Zmienna | Opis                                                              |
+| :--- |:---------------------------------------------------------------------|
+| DYNDNS_USER | Login                                                          |
+|DYNDNS_PASSWORD| Haslo                                                                |
+|DYNDNS_DOMAIN_UPDATE| Subdomeny do aktualizacji, rozdzielone przecinkami                   |
+|REAL_PUBLIC_IP_SERVICE| Adres url, który zwraca w plain text aktualny adres IP               |
+|DNS_UPDATE_SRC| Adres url do prividera dyn dns                                       |
+
+
+## 2. Quick start
+
+
+
+```bash
+docker compose up -d
+```