Document turnserver self-hosting

[pombredanne]

Hi is this self-hostable or is this just a front-end to a closed-source service?

[tstromberg]

@pombredanne - great question!

Goose should be able to; at the moment it talks to 3 sources of data:

• GitHub for periodic polling
• https://github.com/codeGROOVE-dev/sprinkler for realtime websocket notifications
• and a private turnserver for turn-based calculations

The latter hasn't been open-sourced yet; theoretically, it should work without the turnserver, but it won't be able to tell you which PRs are blocking without it. Hope this helps!

[pombredanne]

Thanks for the details... turnserver looks like an essential piece... but it is too bad it is not FOSS all the way.

[pombredanne]

Could you at least post the specs and docs for what this backend server is supposed to do?

[tstromberg]

All great points!

The turnserver backend performs the state machine analysis to determine which paths and individuals are the most likely to move a pull request forward. It's the only IP codeGROOVE is keeping private at the moment, but we plan to share it with customers. The business idea is to use this SaaS portion to earn enough to support the rest of the open-source software we publish.

The client implementation is open-source - https://github.com/codeGROOVE-dev/turnclient/blob/main/pkg/turn/client.go - it's just reaching out to a JSON API that returns this object:

https://github.com/codeGROOVE-dev/turnclient/blob/ee43672b3dc7f977853d3789eb6f34574a630a53/pkg/turn/types.go#L105

Unfortunately, I can't help you much with self-hosting the actual GitHub API surface (it's also closed source), but their API is at least well-documented.