Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcollina/baseswim
A base swim node
https://github.com/mcollina/baseswim
Last synced: about 1 month ago
JSON representation
A base swim node
- Host: GitHub
- URL: https://github.com/mcollina/baseswim
- Owner: mcollina
- License: mit
- Created: 2016-02-13T23:11:15.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-29T12:28:01.000Z (about 8 years ago)
- Last Synced: 2024-11-01T12:42:22.418Z (about 2 months ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 15
- Watchers: 5
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# baseswim
A base swim node
## Install
```
npm i baseswim -g
```
or
```
docker pull matteocollina/baseswim
```
## Usage
```
baseswim [--http 3000] [--port PORT] [peers...]
```
Each peer is in the form of IP:PORT, like 127.0.0.1:7799
### with Docker
On Linux:
```
docker run -p 3000:3000 -p 7799:7799/udp -d matteocollina/baseswim --host `ip addr show wlan0 | grep -Po 'inet \K[\d.]+'` --http 3000
```
__adjut the host configuration to your own interface/ip address__
On Mac:
```
docker run -p 3000:3000 -p 7799:7799/udp -d matteocollina/baseswim --host `ipconfig getifaddr en0` --http 3000
```
__adjut the host configuration to your own interface/ip address__
On docker-machine:
```
docker run -p 3000:3000 -p 7799:7799/udp -d matteocollina/baseswim --host `docker-machine ip default` --http 3000
```
If you need to connect it to other peers pass any peer id at the end,
like for the normal usage.
## as a module
```js
'use strict'
const baseswim = require('baseswim')
const id = '127.0.0.1:7799' // replace your ip address
const swim = baseswim(id, {
http: 3000 // to enable the HTTP endpoints
})
swim.on('peerUp', (peer) => console.log(peer))
swim.on('peerDown', (peer) => console.log(peer))
```
The swim instance is the same of [swim-js](http://npm.im/swim).
See its README for the API.
### constructor options
If you do not pass any options, `baseswim` will bound to a network
interface (not localhost) and pick a free udp port.
You can also pass the host and port as parameters:
```js
const swim = baseswim({
host: '127.0.0.1',
port: 7799
})
```
## HTTP endpoints
If enabled by the `--http` flag, baseswim provides two HTTP endpoint to
control the base node.
### GET /members
Provides a list of the current members, output:
```
$ curl `docker-machine ip default`:3000/members
{
"members": [
{
"host": "192.168.99.100:7799",
"state": 0,
"incarnation": 0
}
]
}
```
### POST /join
Provides a list of the current members, output:
```
curl -X POST -d 'PEER' `docker-machine ip default`:3000/members
```
where PEER is an IP:PORT combination.
## Acknowledgements
baseswim is sponsored by [nearForm](http://nearform.com).
## License
MIT