From c4bd44f3f412e4459d76e4a4f9e52a55a32694d4 Mon Sep 17 00:00:00 2001
From: Eric Dobbs <eric@dobbse.net>
Date: Sun, 19 Jan 2020 15:22:03 -0700
Subject: [PATCH] Provide example farm configuration for friends security
 plugin

---
 examples/k8s/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/examples/k8s/README.md b/examples/k8s/README.md
index 4af0319..37d3ca1 100644
--- a/examples/k8s/README.md
+++ b/examples/k8s/README.md
@@ -16,6 +16,34 @@ using wiki to drive some learning about kubernetes.
       -v "$HOME/workspace/fedwiki:/macos/fedwiki" \
       --name wiki
 
+# example ~/.wiki-k8s/config.json
+
+    {
+      "admin": "any memorable password",
+      "autoseed": true,
+      "farm": true,
+      "cookieSecret": "any random string",
+      "secure_cookie": false,
+      "security_type": "friends",
+      "wikiDomains": {
+        "simple.localtest.me": {
+          "id": "/home/node/.wiki/config.owner.json"
+        }
+      }
+    }
+
+# example ~/.wiki-k8s/config.owner.json
+
+`.friend.secret` must match the `.admin` field from `config.json`
+
+    {
+      "name": "The Owner",
+      "friend": {
+        "secret": "any memorable password"
+      }
+    }
+
+
 # Deploy Wiki
 
     kubectl apply -f wiki.yaml