This commit is contained in:
Alexander Schiemann 2025-05-21 13:58:42 +02:00
parent f09fd556ec
commit 3f604f53fe

View File

@ -1,8 +1,7 @@
# ip2nginx
[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/donate/?hosted_button_id=JNFS79EFEM7C6)
<p align="center">
[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/donate/?hosted_button_id=JNFS79EFEM7C6)<br><br>
<img src="https://nginxproxymanager.com/github.png">
<br><br>
<img src="https://img.shields.io/badge/version-2.12.3-green.svg?style=for-the-badge">
@ -14,6 +13,8 @@
</a>
</p>
## 💡 Project Overview
**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`
@ -22,18 +23,19 @@
## 📚 Table of Contents
- [💡 Project Overview](#project-overview)
- [⚙️ Features](#features)
- [📁 Project Structure](#project-structure)
- [🚀 Update Process: update.php](#update-process-updatephp)
- [⚙️ Features](#-features)
- [📁 Project Structure](#-project-structure)
- [✅ Example Entry in token.json](#-example-tokenjson)
- [✅ Example Entry in meta.json](#-example-metajson)
- [🚀 Update Process: update.php](#-remote-update-api-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)
- [🛠 Environment Setup: check_env.php](#-check_envphp-environment-setup)
- [📅 Cron Setup with run.sh](#-cron-setup-runsh)
- [🔄 Usage Example from pfSense](#-pfsense-shell-example)
- [🛡 Security](#-security-highlights)
- [✅ Requirements](#-requirements)
- [📜 License](#-license)
- [🤝 Author](#-author)
<!-- /TOC -->
---