5
0
mirror of https://github.com/cwinfo/hyperboria-peers.git synced 2024-11-25 07:51:37 +00:00

update README with newline requirement. format all credentials to match

This commit is contained in:
ansuz 2015-11-19 11:40:38 -05:00
parent a9c7be63ae
commit cedfabc4f3
7 changed files with 28 additions and 23 deletions

View File

@ -5,3 +5,4 @@
"user":"weuxel",
"contact": "hype@smash-net.org"
}

View File

@ -4,3 +4,4 @@
"user":"katt",
"contact":"oniichan@mrowr.me",
}

View File

@ -1,7 +1,7 @@
"188.226.183.183:43328":
{
"188.226.183.183:43328": {
"password":"public_access",
"publicKey":"1y1jmqrw4r31jlp6yqmq30067rcp0tsgsdm3cs4k8l33pyfhpwn0.k",
"user":"weuxel",
"contact": "hype@smash-net.org"
}
}

View File

@ -4,3 +4,4 @@
"user":"ansuz",
"contact":"ansuz@transitiontech.ca",
}

View File

@ -1,7 +1,7 @@
"142.4.212.42:1441":
{
"142.4.212.42:1441": {
"password":"201510034nnmj97n54nby3797xt227lr0538ty4",
"publicKey":"9uf222z95bxd7sgvncdtzr2skgjp7vdr472f7u74pc0zxu0pjxl0.k",
"user": "derp",
"contact": "derp@projectmeshnet.org"
}
}

View File

@ -1,7 +1,7 @@
"192.241.171.154:62718":
{
"192.241.171.154:62718": {
"password":"public_access",
"publicKey":"q5nhj9kg6ddmk571jb259mct2ljd10z9xvyf05y3hu66wk4qnk20.k",
"user":"weuxel",
"contact": "hype@smash-net.org"
}
}

View File

@ -44,13 +44,14 @@ By following this scheme, we make it possible for users to programmatically find
## JSON formatting
* Your credentials must be [valid JSON](http://jsonlint.com/).
* Your credentials must be [valid JSON](http://jsonlint.com/) when inserted into a block of curly braces `{}`
* They should be small enough so as to be inserted into a `cjdroute.conf` **as is** without triggering the [connectTo-overflow bug](https://github.com/hyperboria/docs/blob/master/bugs/connectTo-overflow.md).
* They must contain the necessary fields:
+ ip/port
+ password
+ publicKey
* They should also contain a means of contacting the operator
* They should also contain a means of contacting the operator.
* credentials should end with a newline character.
```
@ -60,6 +61,7 @@ By following this scheme, we make it possible for users to programmatically find
"publicKey":"ssxlh80x0bqjfrnbkm1801xsxyd8zd45jkwn1zhlnccqj4hdqun0.k",
"peerName":"your-name-goes-here"
}
```
> Note: the snippet above is **not valid json**. It would need to be wrapped in an additional block of curly braces `{ }`