From 6d6093990d0f5218d6702d2d725b04174c8f4c6c Mon Sep 17 00:00:00 2001
From: southerntofu <southerntofu@thunix.net>
Date: Sat, 20 Mar 2021 18:31:16 +0100
Subject: [PATCH] Minimal README with nginx example config

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1da8d08
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# thunix wiki
+
+Requires a webserver and PHP. The web server needs to be configured to:
+
+- serve wiki.php by default (not index.php)
+- when a requested URL does not correspond to an actual file, pass the requested page to wiki.php?page=
+
+On apache, this is achieved by provided [.htaccess](.htaccess). On nginx, you can do something like:
+
+```
+server {
+	listen 80;
+	root /var/www/wiki_webroot;
+	index wiki.php;
+	server_name _;
+
+	location ~ \.php$ {
+		include snippets/fastcgi-php.conf;
+		fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
+	}
+
+	location ~ ^/(.+)$ {
+		try_files $uri $uri/ /wiki.php?page=$1;
+	}
+}
+```