ReadMe.md
This commit is contained in:
parent
5c0511db27
commit
59fa78bf18
50
README.md
50
README.md
@ -2,30 +2,40 @@
|
||||
|
||||
[](https://www.paypal.com/donate/?hosted_button_id=JNFS79EFEM7C6)
|
||||
|
||||
<!-- 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 -->
|
||||
|
||||
|
||||
<p align="center">
|
||||
<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">
|
||||
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
|
||||
<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
|
||||
</a>
|
||||
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
|
||||
<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
**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`
|
||||
|
||||
<!-- 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
|
||||
@ -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)**
|
||||
Loading…
x
Reference in New Issue
Block a user