ForgeFlux/docs
2
0
Fork 0
Code Issues 1 Pull requests 2 Projects Releases Packages Wiki Activity
docs/content/getting-started/how.md
dat-adi f82ddc5d3e Terse content 
Reworked the content to be a bit more polished.
2022-01-22 11:11:58 +05:30

1.3 KiB
Raw Blame History

+++ title = "How does it work?" weight = 40 +++

How does it work?

Bridges connect people, and so does ForgeFlux!

Interface

The bridging component in ForgeFlux is called Interface.

Interfaces are programs that run on either side of the bridge, i.e, a bridge requires the participation of two interfaces. Currently, Interfaces bridge the following operations:

  • Pull Requests
  • Issues
  • Comments

An Interface implementation for a software forge is able to talk to the forge's API and speak ActivityPub protocol for server-to-server communications. This architecture makes it possible to implement an Interface for any forge setup.

Northstar

Since Interfaces run external to the forges, a method to find Interfaces that service forges was required.

Northstar is a discovery service that maps an Interface and the forge that it services. It acts very similar to DNS, except instead of querying host names with intent to find corresponding IP address, Northstar is queried with the forge's host name to discover the Interfaces that service it.

Resources