Skip to content

forgeflux-org/northstar

Repository files navigation

North Star

A discovery service for ForgeFlux ecosystem

Documentation Docker Build codecov

Why

ForgeFlux allows for multiple interfaces to be run against a single software forge. Also, the protocol is flexible enough to support multiple types of software forges(GitLab, GitHub, etc). The protocol's decentralised nature makes it impossible to create a constant record of which interfaces service forges.

So we created a discovery service which stores records of interfaces and the forges they service. This is very similar to the way DNS works. In DNS, hostname is resolved to IP address. Here, software forge URL is resolved to URLs of interfaces that service the queried forge.

Live instance

A live instance is available at https://northstar.forgeflux.org/.

API Specification

OpenAPI specification is available at https://forgeflux-org.github.io/northstar/.

Deployment

Docker images are run against every commit on master. We are currently in alpha status, expect breaking changes while deploying images tagged latest.

We'll freeze code once we have a stable release.

docker run -d \
	-v /path/to/your/northstar/config.toml:/home/northstar/app/config/settings.toml
	-p 3001:3000 \
	forgedfed/northstar

Hacking

This codebase is fairly straight forward, see Makefile for some helpful commands.