From 3bf3c3392ad4e0d217f25de142b0f31eb5105e6f Mon Sep 17 00:00:00 2001
From: Michael Williams <michael.williams@enspiral.com>
Date: Tue, 10 Nov 2020 18:37:10 +1300
Subject: [PATCH] add v2.2.0 migration guide

and change `install.sh` to match.

ref: https://github.com/ahdinosaur/ssb-pub/issues/37#issuecomment-724459234
---
 README.md  | 36 +++++++++++++++++++++++++++++++++---
 install.sh |  2 +-
 2 files changed, 34 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index ee55640..2fcc7bd 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ easily host your own [Secure ScuttleButt (SSB)](https://www.scuttlebutt.nz) pub
 
 if you feel like sharing your pub, please add it to [the informal registry of pubs](https://github.com/ssbc/scuttlebot/wiki/Pub-Servers) as a private pub with your contact details so newbies may request an invite from you!
 
-(if you are running a v1 pub, [migrate to the latest v2!](#migrating-from-v1-to-v2) :tada: )
+(if you are running a pub version less than 2.2.0, please [upgrade](#upgrading)! :tada: )
 
 :heart:
 
@@ -85,7 +85,7 @@ ssh root@your.ip.address.here
 >         {
 >           "scope": "public",
 >           "host": "0.0.0.0",
->           "external": ["hostname.yourdomain.tld"],
+>           "external": "hostname.yourdomain.tld",
 >           "transform": "shs",
 >           "port": 8008
 >         }
@@ -177,7 +177,7 @@ cat > ~/ssb-pub-data/config <<EOF
         {
           "scope": "public",
           "host": "0.0.0.0",
-          "external": ["${EXTERNAL}"],
+          "external": "${EXTERNAL}",
           "transform": "shs",
           "port": 8008
         }
@@ -413,6 +413,36 @@ docker rm sbot
 ./create-sbot
 ```
 
+### migrating from `<2.2.0` to `2.2.0+`
+
+edit your `~/ssb-pub-data/config`, such that **`connections.incoming.net[].external`** changes from an array of strings to a single string.
+
+```diff
+{
+  "connections": {
+    "incoming": {
+      "net": [
+        {
+          "scope": "public",
+          "host": "0.0.0.0",
+-          "external": ["hostname.yourdomain.tld"],
++          "external": "hostname.yourdomain.tld",
+          "transform": "shs",
+          "port": 8008
+        }
+      ]
+    },
+    "outgoing": {
+      "net": [
+        {
+          "transform": "shs"
+        }
+      ]
+    }
+  }
+}
+```
+
 ### migrating from `v1` to `v2`
 
 for a `v1` pub owner to update to the latest `v2` version of `ssb-pub`:
diff --git a/install.sh b/install.sh
index 1d786ae..1c59d7c 100755
--- a/install.sh
+++ b/install.sh
@@ -38,7 +38,7 @@ cat > ~/ssb-pub-data/config <<EOF
         {
           "scope": "public",
           "host": "0.0.0.0",
-          "external": ["${EXTERNAL}"],
+          "external": "${EXTERNAL}",
           "transform": "shs",
           "port": 8008
         }