Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/writeas/go-nodeinfo

NodeInfo server implemented in Go
https://github.com/writeas/go-nodeinfo

federation fediverse go nodeinfo

Last synced: 1 day ago
JSON representation

NodeInfo server implemented in Go

Awesome Lists containing this project

README

        

# go-nodeinfo

[![GoDoc](https://godoc.org/github.com/writeas/go-nodeinfo?status.svg)](https://godoc.org/github.com/writeas/go-nodeinfo)
[![Discuss on our forum](https://img.shields.io/discourse/https/discuss.write.as/users.svg?label=forum)](https://discuss.write.as/c/development)

go-nodeinfo is an implementation of [NodeInfo](https://github.com/jhass/nodeinfo), a standard metadata format for federated social networks, in Go (golang).

## Usage

`nodeinfo.Service` integrates with your existing `net/http` server.

```go
package main

import (
"github.com/writeas/go-nodeinfo"
"net/http"
)

func main() {
cfg := nodeinfo.Config{
BaseURL: "http://localhost:8080",
InfoURL: "/api/nodeinfo",

Metadata: nodeinfo.Metadata{
NodeName: "Agora",
NodeDescription: "A federated something-something.",
Private: false,
},
Protocols: []nodeinfo.NodeProtocol{
nodeinfo.ProtocolActivityPub,
},
Services: nodeinfo.Services{
Inbound: []nodeinfo.NodeService{},
Outbound: []nodeinfo.NodeService{
nodeinfo.ServiceTwitter,
nodeinfo.ServiceTumblr,
},
},
Software: nodeinfo.SoftwareInfo{
Name: "Agora",
Version: "1.0",
},
}
ni := nodeinfo.NewService(cfg, nodeInfoResolver{})

http.Handle(nodeinfo.NodeInfoPath, http.HandlerFunc(ni.NodeInfoDiscover))
http.Handle(cfg.InfoURL, http.HandlerFunc(ni.NodeInfo))

http.ListenAndServe(":8080", nil)
}

type nodeInfoResolver struct{}

func (r nodeInfoResolver) IsOpenRegistration() (bool, error) {
return true, nil
}

func (r nodeInfoResolver) Usage() (nodeinfo.Usage, error) {
u := nodeinfo.Usage{
Users: nodeinfo.UsageUsers{
Total: 1,
},
LocalPosts: 1,
}
return u, nil
}
```