# ssb-discover-lan-peers

> auto discover ssb-servers on the local network (the counterpart to ssb-lan)

Latest version **1.0.0** (published 2020-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install ssb-discover-lan-peers
pnpm add ssb-discover-lan-peers
yarn add ssb-discover-lan-peers
bun add ssb-discover-lan-peers
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-09-01 |
| First published | 2020-09-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 2.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jan Bölsche |
| Maintainers | regular |

## Links

- npm: https://www.npmjs.com/package/ssb-discover-lan-peers
- Repository: https://github.com/regular/ssb-discover-lan-peers
- Homepage: https://github.com/regular/ssb-discover-lan-peers#readme
- Issues: https://github.com/regular/ssb-discover-lan-peers/issues
- npm.io page: https://npm.io/package/ssb-discover-lan-peers

## Dependencies (3)

- [ssb-lan](https://npm.io/package/ssb-lan.md) ^0.2.0
- [pull-stream](https://npm.io/package/pull-stream.md) ^3.6.14
- [pull-through-end](https://npm.io/package/pull-through-end.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2020-09-01

## README

ssb-discover-lan-peers
---

Uses ssb-lan to discover ssb peers on the local network sharing a specified caps.shs (network key). This is useful for clients to auto-discover ssb-servers around them. The differences to ssb-lan are:

- it does not broadcast
- it is not a plugin for ssb-server but a stand-alone module (that wraps ssb-lan)

``` js
const pull = require('pull-stream')
const discovery = require('.')

pull(
  discovery('FZ0EmZO8NAhI8BLk5F1gxdBOTOO42BV9V6R4+KZS77c=', {legacy: false}),
  pull.take(1),
  pull.log()
)
```

output:

```
{
  address: 'net:192.168.1.125:63942~shs:B7xq7G7kCUJ1YIlb8p29UizHP/p8Aw3DVrdx00EDO8g=',
  verified: true
}
```

---
License: MIT

---
_Source: https://npm.io/package/ssb-discover-lan-peers · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._