SAFE-CAP/ip2nginx
SAFE-CAP/ip2nginx
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

1

Browse Source
This commit is contained in:
Alexander Schiemann 2025-05-21 14:18:05 +02:00
parent 13416df40e
commit 06c41d7feb
1 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,6 +1,8 @@
# ip2nginx # ip2nginx
<p align="center"> <p align="center">
<a href="https://safe-cap.com/">
<img src="https://safe-cap.com/git/safe-cap-logo.png" width="100" height="100";> <img src="https://safe-cap.com/git/safe-cap-logo.png" width="100" height="100";>
</a>
<br><br> <br><br>
<img src="https://img.shields.io/badge/version-0.0.1-green.svg?style=for-the-badge"> <img src="https://img.shields.io/badge/version-0.0.1-green.svg?style=for-the-badge">
<a href="https://www.paypal.com/donate/?hosted_button_id=JNFS79EFEM7C6"> <a href="https://www.paypal.com/donate/?hosted_button_id=JNFS79EFEM7C6">
@ -20,6 +22,8 @@
## 📚 Table of Contents ## 📚 Table of Contents
- [💡 Project Overview](#-project-overview) - [💡 Project Overview](#-project-overview)
- [🏠 What is ip2nginx?](#-what-is-ip2nginx)
- [💡 Example Use Case](#-example-use-case)
- [⚙️ Features](#-features) - [⚙️ Features](#-features)
- [📁 Project Structure](#-project-structure) - [📁 Project Structure](#-project-structure)
- [🚀 Update Process: update.php](#-remote-update-api-updatephp) - [🚀 Update Process: update.php](#-remote-update-api-updatephp)
@ -37,6 +41,30 @@
--- ---
## 🏠 What is ip2nginx?
ip2nginx is a self-hosted system that allows you to make services running on your home network (like a NAS, internal web apps, or router interface) accessible under your own domain — even if your public IP address changes.
Unlike third-party solutions like DynDNS, No-IP, or other dynamic DNS providers, this tool gives you full control and privacy by updating your reverse proxy configuration directly, without modifying DNS records or relying on external providers.
How It Works:
Your home device (e.g. pfSense or another gateway) periodically sends its current public IP to your server via an API request.
The server updates the reverse proxy configuration (nginx.conf) with the new IP.
The proxy_pass directive is updated inside the specific location block for the target domain.
NGINX is reloaded automatically to apply changes.
---
## 💡 Example Use Case
You want to host https://home.example.com and route it to a web interface at your home (like pfSense or a Raspberry Pi), but your IP changes regularly due to your ISP.
With ip2nginx, the server automatically updates the NGINX reverse proxy so your domain continues working — securely and without dynamic DNS services.
---
## ⚙️ Features ## ⚙️ Features
- Accepts remote updates via `update.php` using **token-authenticated** requests. - Accepts remote updates via `update.php` using **token-authenticated** requests.