Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grandcat/zeroconf
mDNS / DNS-SD Service Discovery in pure Go (also known as Bonjour)
https://github.com/grandcat/zeroconf
avahi bonjour dns-sd ipv6 mdns service-discovery zero-configuration zeroconf
Last synced: about 2 months ago
JSON representation
mDNS / DNS-SD Service Discovery in pure Go (also known as Bonjour)
- Host: GitHub
- URL: https://github.com/grandcat/zeroconf
- Owner: grandcat
- License: other
- Created: 2016-07-25T13:00:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-07T12:06:15.000Z (10 months ago)
- Last Synced: 2024-06-18T11:18:53.919Z (3 months ago)
- Topics: avahi, bonjour, dns-sd, ipv6, mdns, service-discovery, zero-configuration, zeroconf
- Language: Go
- Homepage:
- Size: 105 KB
- Stars: 724
- Watchers: 24
- Forks: 168
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ZeroConf: Service Discovery with mDNS
=====================================
ZeroConf is a pure Golang library that employs Multicast DNS-SD for
* browsing and resolving services in your network
* registering own services
in the local network.
It basically implements aspects of the standards
[RFC 6762](https://tools.ietf.org/html/rfc6762) (mDNS) and
[RFC 6763](https://tools.ietf.org/html/rfc6763) (DNS-SD).
Though it does not support all requirements yet, the aim is to provide a compliant solution in the long-term with the community.
By now, it should be compatible to [Avahi](http://avahi.org/) (tested) and Apple's Bonjour (untested).
Target environments: private LAN/Wifi, small or isolated networks.
[](https://godoc.org/github.com/grandcat/zeroconf)
[](https://goreportcard.com/report/github.com/grandcat/zeroconf)
[](https://github.com/grandcat/zeroconf/actions/workflows/go-test.yml)
## Install
Nothing is as easy as that:
```bash
$ go get -u github.com/grandcat/zeroconf
```
This package requires **Go 1.7** (context in std lib) or later.
## Browse for services in your local network
```go
// Discover all services on the network (e.g. _workstation._tcp)
resolver, err := zeroconf.NewResolver(nil)
if err != nil {
log.Fatalln("Failed to initialize resolver:", err.Error())
}
entries := make(chan *zeroconf.ServiceEntry)
go func(results <-chan *zeroconf.ServiceEntry) {
for entry := range results {
log.Println(entry)
}
log.Println("No more entries.")
}(entries)
ctx, cancel := context.WithTimeout(context.Background(), time.Second*15)
defer cancel()
err = resolver.Browse(ctx, "_workstation._tcp", "local.", entries)
if err != nil {
log.Fatalln("Failed to browse:", err.Error())
}
<-ctx.Done()
```
A subtype may added to service name to narrow the set of results. E.g. to browse `_workstation._tcp` with subtype `_windows`, use`_workstation._tcp,_windows`.
See https://github.com/grandcat/zeroconf/blob/master/examples/resolv/client.go.
## Lookup a specific service instance
```go
// Example filled soon.
```
## Register a service
```go
server, err := zeroconf.Register("GoZeroconf", "_workstation._tcp", "local.", 42424, []string{"txtv=0", "lo=1", "la=2"}, nil)
if err != nil {
panic(err)
}
defer server.Shutdown()
// Clean exit.
sig := make(chan os.Signal, 1)
signal.Notify(sig, os.Interrupt, syscall.SIGTERM)
select {
case <-sig:
// Exit by user
case <-time.After(time.Second * 120):
// Exit by timeout
}
log.Println("Shutting down.")
```
Multiple subtypes may be added to service name, separated by commas. E.g `_workstation._tcp,_windows` has subtype `_windows`.
See https://github.com/grandcat/zeroconf/blob/master/examples/register/server.go.
## Features and ToDo's
This list gives a quick impression about the state of this library.
See what needs to be done and submit a pull request :)
* [x] Browse / Lookup / Register services
* [x] Multiple IPv6 / IPv4 addresses support
* [x] Send multiple probes (exp. back-off) if no service answers (*)
* [ ] Timestamp entries for TTL checks
* [ ] Compare new multicasts with already received services
_Notes:_
(*) The denoted features might not be perfectly standards compliant, but shouldn't cause any problems.
Some tests showed improvements in overall robustness and performance with the features enabled.
## Credits
Great thanks to [hashicorp](https://github.com/hashicorp/mdns) and to [oleksandr](https://github.com/oleksandr/bonjour) and all contributing authors for the code this projects bases upon.
Large parts of the code are still the same.
However, there are several reasons why I decided to create a fork of the original project:
The previous project seems to be unmaintained. There are several useful pull requests waiting. I merged most of them in this project.
Still, the implementation has some bugs and lacks some other features that make it quite unreliable in real LAN environments when running continously.
Last but not least, the aim for this project is to build a solution that targets standard conformance in the long term with the support of the community.
Though, resiliency should remain a top goal.