From 2489e0462820cd76046cf1256500a67172a0ab87 Mon Sep 17 00:00:00 2001
From: Ferenc Schulcz <schulcz.ferenc@gmail.com>
Date: Wed, 16 Oct 2024 16:01:08 +0200
Subject: [PATCH] Add README

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b026d43
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+DynDNS frontend plugin for sfphoton modular web server
+======================================================
+
+This is a DynDNS frontend and reverse proxy for my personal website. Features:
+
+- Register and update DynDNS records
+- Authentication and authorization
+
+This frontend uses my [DynDNS implementation](https://git.sch.bme.hu/schulczf/dyndns-server) as a backend. It is only secure if this runs on localhost or is only available through a secure link.
+
+Usage
+-----
+
+Just install this under sfphoton modular web server as any plugin. Add permissions `dyndns` to website users.
+
+Dependencies
+------------
+
+My [DynDNS implementation](https://git.sch.bme.hu/schulczf/dyndns-server).
+
+Required config
+---------------
+
+```json
+{
+		"DYNDNS_SERVER_URL": "http://127.0.0.1:3002",
+}
+```
\ No newline at end of file
-- 
GitLab