config

README

GitHub-Bounty

GitHub bounty can be used to collect donations for GitHub Issues.

Example use-cases are shown in .

Host it yourself (more privacy, usable in private repos) or use my hosted service (non-custodial, only useable in public repos).

Usage

In order to use our hosted service you need to have a lnd node running with a publicly reachable rpc server.

1. create a lnd-connect string with invoice macaroon permissions i.e. lndconnect -j --invoice

2. Create a webhook in your repo with https://gh.donnerlab.com/wh/{lnd connect string without lndconnect://} the secret is "secret"

1. Select individual events with only the issues tag

1. Your repo should now be active. You can now add the 'bounty' label to any issue

1. The bot will comment and users can request invoices with the url (they can change the amount from the url)

Documentation

Index

• Variables
• type Config
  • func DefaultConfig() *Config

Variables

var (
	DefaultSecret         = "secret"
	DefaultHttpUrl        = "http://localhost:8123"
	DefaultListenAddress  = "0.0.0.0:8123"
	DefaultStaticFilePath = "./dist"
	DefaultDbFilePath     = "./db"
)

Types

type Config

type Config struct {
	GithubAccessToken string `long:"token" description:"github access token with full repo permissions" required:"true"`
	Secret            string `long:"secret" description:"webhook secret"`
	HttpUrl           string `long:"http-url" description:"http url for invoice delivery"`
	ListenAddress     string `long:"listen-address" description:"listen address"`
	DbFilePath        string `long:"db-filepath" description:"path to db file"`
	StaticFilePath    string `long:"static-filepath" description:"path to web files"`
	LndConnect        string `long:"lndconnect" description:"lndconnect string with admin permissions" required:"true"`
}

func DefaultConfig

func DefaultConfig() *Config