docs/content/Northstar/about.md
Aravinth Manivannan 3bd7ef3ce9
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
feat: adjust favicon
2023-10-01 23:35:53 +05:30

18 lines
591 B
Markdown

+++
title = "About Northstar"
insert_anchor_links = "right"
+++
# Northstar
Northstar is a lookup service, which acts as a source of information
for interfaces which hold particular forge information.
An [Interface](@/Interface/_index.md) connects and looks
through an instance of Northstar, to find the appropriate the forge
information that it seeks.
An instance of Northstar has the functionality to act as an API to
register and provide forge information.
These routes/payloads are covered in the [OpenAPI specification](https://northstar.forgeflux.org/docs/openapi/)
for Northstar.