https://github.com/fc00/peers-api

find hyperboria peers via http(s)
https://github.com/fc00/peers-api

Last synced: 5 days ago
JSON representation

find hyperboria peers via http(s)

• Host: GitHub
• URL: https://github.com/fc00/peers-api
• Owner: fc00
• License: agpl-3.0
• Created: 2016-09-29T10:45:33.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-11T14:51:51.000Z (over 7 years ago)
• Last Synced: 2024-08-01T12:26:25.182Z (3 months ago)
• Language: HTML
• Homepage: https://peers.fc00.io
• Size: 27.3 KB
• Stars: 6
• Watchers: 4
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - fc00/peers-api - find hyperboria peers via http(s) (others)

README

        
# peers-api (WIP)

find hyperboria peers via http

## Why

Cjdns requires that you manually add peers to your configuration file in order to join a network.

The `hyperboria-peers` package contains a geographically sorted list of publically available peers in a JSON data structure.

This server exposes a queryable interface to that data structure, to facillitate automatic configuration of new cjdns nodes.

## Installation

```

git clone https://github.com/fc00/peers-api;

cd peers-api;

npm install;

cp config.js.dist config.js;

node server;

```

## Usage (TBD)

```Bash

# Find peers in North America

curl https://peers.fc00.io/1/location/na

```

## See also

[a dedicated client written in nodejs](https://github.com/fc00/peers-api-client)