ReadMe.md

This commit is contained in:
Alexander Schiemann 2025-05-21 13:43:55 +02:00
parent 5c0511db27
commit 59fa78bf18

View File

@ -2,30 +2,40 @@
[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/donate/?hosted_button_id=JNFS79EFEM7C6) [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/donate/?hosted_button_id=JNFS79EFEM7C6)
<!-- TOC --> <p align="center">
## 📚 Table of Contents <img src="https://nginxproxymanager.com/github.png">
<br><br>
- [💡 Project Overview](#-project-overview) <img src="https://img.shields.io/badge/version-2.12.3-green.svg?style=for-the-badge">
- [⚙️ Features](#-features) <a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
- [📁 Project Structure](#-project-structure) <img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
- [🚀 Update Process: update.php](#-update-process-updatephp) </a>
- [🚀 Update Process: updater.php](#-update-process-updaterphp) <a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
- [✅ Example Entry in meta.json](#-example-entry-in-metajson) <img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
- [✅ Example Entry in token.json](#-example-entry-in-tokenjson) </a>
- [🛡 Security](#-security) </p>
- [🔄 Usage Example from pfSense](#-usage-example-from-pfsense)
- [📅 Cron Setup with run.sh](#-cron-setup-with-runsh)
- [✅ Dependencies](#-dependencies)
- [📜 License](#-license)
- [🤝 Author](#-author)
<!-- /TOC -->
**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. **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` **Current Version:** `0.0.1`
<!-- TOC -->
## 📚 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)
<!-- /TOC -->
--- ---
## ⚙️ Features ## ⚙️ 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)** **Maintained by [SAFE-CAP / Alexander Schiemann](https://safe-cap.com)**