Skip to content

Commit

Permalink
add v2.2.0 migration guide
Browse files Browse the repository at this point in the history
and change `install.sh` to match.

ref: #37 (comment)
  • Loading branch information
ahdinosaur committed Nov 10, 2020
1 parent 37729f9 commit 3bf3c33
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 4 deletions.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -85,7 +85,7 @@ ssh [email protected]
> {
> "scope": "public",
> "host": "0.0.0.0",
> "external": ["hostname.yourdomain.tld"],
> "external": "hostname.yourdomain.tld",
> "transform": "shs",
> "port": 8008
> }
Expand Down Expand Up @@ -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
}
Expand Down Expand Up @@ -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`:
Expand Down
2 changes: 1 addition & 1 deletion install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down

0 comments on commit 3bf3c33

Please sign in to comment.