mirror of
https://github.com/go-gitea/gitea
synced 2024-11-09 11:31:34 +01:00
babab0bf5e
Nodeinfo is a way to expose certain metadata about a server for use of discovery regarding functionality of its federation capabilities. Two endpoints are required: 1. `/.well-known/nodeinfo` which informs client where it can find the location of the location of its metadata (including which version of the schema is used) 2. the endpoint which exposes the metadata in json format according to schema. Notes: * `openRegistrations` is a required field, but I propose to set to false as default in case someone writes a crawler to discover "open" gitea instances * to limit data leakage I also propose to not include the `usage` field (note it is required so it should be included, but left as empty). More info: https://github.com/jhass/nodeinfo https://github.com/jhass/nodeinfo/tree/main/schemas/2.1 http://nodeinfo.diaspora.software/protocol.html
45 lines
1.2 KiB
Go
45 lines
1.2 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package misc
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/modules/structs"
|
|
)
|
|
|
|
// NodeInfo returns the NodeInfo for the Gitea instance to allow for federation
|
|
func NodeInfo(ctx *context.APIContext) {
|
|
// swagger:operation GET /nodeinfo miscellaneous getNodeInfo
|
|
// ---
|
|
// summary: Returns the nodeinfo of the Gitea application
|
|
// produces:
|
|
// - application/json
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/NodeInfo"
|
|
|
|
nodeInfo := &structs.NodeInfo{
|
|
Version: "2.1",
|
|
Software: structs.NodeInfoSoftware{
|
|
Name: "gitea",
|
|
Version: setting.AppVer,
|
|
Repository: "https://github.com/go-gitea/gitea.git",
|
|
Homepage: "https://gitea.io/",
|
|
},
|
|
Protocols: []string{"activitypub"},
|
|
Services: structs.NodeInfoServices{
|
|
Inbound: []string{},
|
|
Outbound: []string{},
|
|
},
|
|
OpenRegistrations: setting.Service.ShowRegistrationButton,
|
|
Usage: structs.NodeInfoUsage{
|
|
Users: structs.NodeInfoUsageUsers{},
|
|
},
|
|
}
|
|
ctx.JSON(http.StatusOK, nodeInfo)
|
|
}
|