github

README

GitHub connector

GitHub connector is a OAuth plug-in designed to support GitHub OAuth login.

How to use

Build

./answer build --with github.com/answerdev/plugins/connector/github

Configuration

• ClientID - GitHub OAuth client ID
• ClientSecret - GitHub OAuth client secret

In the https://github.com/settings/applications/new page, config the Authorization callback URL as https://example.com/answer/api/v1/connector/redirect/github

Documentation

Index

• type Connector
  • func (g *Connector) ConfigFields() []plugin.ConfigField
  • func (g *Connector) ConfigReceiver(config []byte) error
  • func (g *Connector) ConnectorLogoSVG() string
  • func (g *Connector) ConnectorName() plugin.Translator
  • func (g *Connector) ConnectorReceiver(ctx *plugin.GinContext, receiverURL string) (userInfo plugin.ExternalLoginUserInfo, err error)
  • func (g *Connector) ConnectorSender(ctx *plugin.GinContext, receiverURL string) (redirectURL string)
  • func (g *Connector) ConnectorSlugName() string
  • func (g *Connector) Info() plugin.Info
• type ConnectorConfig

Types

type Connector

type Connector struct {
	Config *ConnectorConfig
}

func (*Connector) ConfigFields

func (g *Connector) ConfigFields() []plugin.ConfigField

func (*Connector) ConfigReceiver

func (g *Connector) ConfigReceiver(config []byte) error

func (*Connector) ConnectorLogoSVG

func (g *Connector) ConnectorLogoSVG() string

func (*Connector) ConnectorName

func (g *Connector) ConnectorName() plugin.Translator

func (*Connector) ConnectorReceiver

func (g *Connector) ConnectorReceiver(ctx *plugin.GinContext, receiverURL string) (userInfo plugin.ExternalLoginUserInfo, err error)

func (*Connector) ConnectorSender

func (g *Connector) ConnectorSender(ctx *plugin.GinContext, receiverURL string) (redirectURL string)

func (*Connector) ConnectorSlugName

func (g *Connector) ConnectorSlugName() string

func (*Connector) Info

func (g *Connector) Info() plugin.Info

type ConnectorConfig

type ConnectorConfig struct {
	ClientID     string `json:"client_id"`
	ClientSecret string `json:"client_secret"`
}