diff --git a/README.md b/README.md index 4adae37..ffb3428 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,40 @@ [](https://www.paypal.com/donate/?hosted_button_id=JNFS79EFEM7C6) - -## 📚 Table of Contents - -- [💡 Project Overview](#-project-overview) -- [⚙️ Features](#️-features) -- [📁 Project Structure](#-project-structure) -- [🚀 Update Process: update.php](#-update-process-updatephp) -- [🚀 Update Process: updater.php](#-update-process-updaterphp) -- [✅ Example Entry in meta.json](#-example-entry-in-metajson) -- [✅ Example Entry in token.json](#-example-entry-in-tokenjson) -- [🛡 Security](#-security) -- [🔄 Usage Example from pfSense](#-usage-example-from-pfsense) -- [📅 Cron Setup with run.sh](#-cron-setup-with-runsh) -- [✅ Dependencies](#-dependencies) -- [📜 License](#-license) -- [🤝 Author](#-author) - - - +
**ip2nginx** is a lightweight and secure system for dynamically updating NGINX reverse proxy configurations based on public IP address changes, typically reported by edge devices like **pfSense**. It ensures that NGINX always routes traffic through the correct IP, even in dynamic environments. **Current Version:** `0.0.1` + +## 📚 Table of Contents + +- [💡 Project Overview](#project-overview) +- [⚙️ Features](#features) +- [📁 Project Structure](#project-structure) +- [🚀 Update Process: update.php](#update-process-updatephp) +- [🚀 Update Process: updater.php](#update-process-updaterphp) +- [✅ Example Entry in meta.json](#example-entry-in-metajson) +- [✅ Example Entry in token.json](#example-entry-in-tokenjson) +- [🛡 Security](#security) +- [🔄 Usage Example from pfSense](#usage-example-from-pfsense) +- [📅 Cron Setup with run.sh](#cron-setup-with-runsh) +- [✅ Dependencies](#dependencies) +- [📜 License](#license) +- [🤝 Author](#author) + + --- ## ⚙️ Features @@ -194,4 +204,6 @@ MIT (or similar): Open-source, free for use and modification. --- +## 🤝 Autor + **Maintained by [SAFE-CAP / Alexander Schiemann](https://safe-cap.com)** \ No newline at end of file