Mirror of Hyperboria peers repository.

ansuz 98241cff85 bump semver 7 years ago
AS 4db86082c2 Deleting my Singapore Node; This node will continue to work but using it as a new peer is discouraged (#57) 7 years ago
EU ce909319e2 Cleaned up formatting (#64) 7 years ago
NA 9114bb0579 No, I just want to update. THIS IS NOT IPV6. (#68) 7 years ago
.gitignore fd95e35979 bump package.json because of readme 7 years ago
.travis.yml 74b19f6b99 Use new build system (followed old docs before) 8 years ago
README.md 8755dd9583 description in blockquotes 7 years ago
index.js 65825d7fbc alias __dirname, use 'read' 7 years ago
package.json 98241cff85 bump semver 7 years ago
tests.js dc3b822252 no more hardcoding. search the directory structure for .k files and load them 7 years ago
tests.py 27b646419b Improve "JSON not properly formatted" error message to say how to fix it (#59) 7 years ago

README.md

Build Status

A geographically sorted list of public peering credentials for joining Hyperboria.

Hyperboria uses cjdns to construct an end-to-end-encrypted ipv6 mesh network. Connections between nodes are established manually, and traffic is restricted to the resulting social graph.

This repository exists for those who don't already know somebody on Hyperboria.

Using credentials

First, set up a cjdns node.

To connect your node to one of these public peers, follow the steps in the cjdns README.

Adding your public node's credentials

If you've created a public node, and would like to have it listed here, fork the repo, add a keyfile, and submit a PR.

Filepath conventions

Credentials are sorted geographically, by continent, region, and municipality.

For example, a node in New York City is listed at NA/us/newyork.

Region and municipality codes are based on self identification, not any ISO standard. An operator might prefer to list their node in Cascadia instead of Washington state. For simplicity's sake, we'd prefer that new credentials conform to existing structures.

JSON formatting

We have tried to standardize the structure of the actual credential files, as such, they have the strictest requirements of anything in this repository.

  • Your credentials must be valid JSON.
  • They must contain the necessary fields:
    • ip/port
    • password
    • publicKey
    • contact (a means of contacting the operator)
  • credentials should be formatted such that:

    • there is a space after each colon
    • indentation uses four spaces
    • the file ends with a newline character.

      {
      "192.168.1.5:10326": {
      "login": "default-login",
      "password": "nq1uhmf06k8c5594jqmpgy26813b81s",
      "publicKey": "ssxlh80x0bqjfrnbkm1801xsxyd8zd45jkwn1zhlnccqj4hdqun0.k",
      "peerName": "your-name-goes-here"
      }
      }
      

Naming your entry

Credential files must end with .k. Otherwise, you can name your file whatever you want, but for simplicity's sake, avoid characters which will need to be escaped at the command line (or within the javascript api).

Javascript API

Peering credentials in this repository can be accessed via a simple Javascript API (using Nodejs).

It's available as a module on npm:

npm install hyperboria-peers

Usage

var Peers = require("hyperboria-peers");

/*  return a list of public peers located in North America */
Peers.filter(function (creds, path) {
    return path.indexOf('NA') !== -1;
});

/*  return a list of public keys */
Peers.map(function (creds, path) {
    return creds[Object.keys(creds)[0]].publicKey;
});

/*  the underlying data is exposed in a nested json structure */
console.log(Peers.peers);

console.log(Peers.peers.NA.us.california);