Developer docs / Bundled addons
GitHub Sign in with GitHub.
Field Value Addon id sso-githubKind ssoProvides githubEngine wasmABI 0.2.0Version 0.1.0 Author MythicalSystems Source extensions/addons/sso-githubPermissions (shown at install) network.outbound
# CapabilitiesCapability Value httpgithub.com, api.github.com, $setting:token_url, $setting:userinfo_urlsecretsnone
# Events and hooksWhat Value Listens to (events) none Hooks none Emits none Mixins none Scheduled jobs none
# Settings and secretsSetting Type Required client_idtextno client_secretsecretno button_labeltextno allow_registerboolno link_by_verified_emailboolno allow_staffboolno authorize_urltextno token_urltextno userinfo_urltextno scopetextno
Secrets (stored encrypted, never returned by the API): none.
Outbound HTTP allowed to: github.com, api.github.com, $setting:token_url, $setting:userinfo_url. $server is the hostname of the server configured for the product, $setting:<key> the host of that setting.
# addon.jsonextensions/addons/sso-github/addon.json JSON Wrap Copy
{
" abi" : " 0.2.0" ,
" author" : " MythicalSystems" ,
" capabilities" : {
" http" : [
" github.com" ,
" api.github.com" ,
" $setting:token_url" ,
" $setting:userinfo_url" ] ,
" secrets" : [ ] } ,
" description" : " addons.desc.sso.github" ,
" engine" : " wasm" ,
" id" : " sso-github" ,
" kind" : " sso" ,
" name" : " GitHub" ,
" permissions" : [
" network.outbound" ] ,
" provides" : " github" ,
" settings" : [
{
" default" : " " ,
" key" : " client_id" ,
" kind" : " text" ,
" label" : " addons.sso.setting.client_id" ,
" required" : false
} ,
{
" default" : " " ,
" key" : " client_secret" ,
" kind" : " secret" ,
" label" : " addons.sso.setting.client_secret" ,
" required" : false
} ,
{
" default" : " " ,
" key" : " button_label" ,
" kind" : " text" ,
" label" : " addons.sso.setting.button_label" ,
" required" : false
} ,
{
" default" : true ,
" key" : " allow_register" ,
" kind" : " bool" ,
" label" : " addons.sso.setting.allow_register" ,
" required" : false
} ,
{
" default" : false ,
" key" : " link_by_verified_email" ,
" kind" : " bool" ,
" label" : " addons.sso.setting.link_by_verified_email" ,
" required" : false
} ,
{
" default" : false ,
" key" : " allow_staff" ,
" kind" : " bool" ,
" label" : " addons.sso.setting.allow_staff" ,
" required" : false
} ,
{
" default" : " " ,
" key" : " authorize_url" ,
" kind" : " text" ,
" label" : " addons.sso.setting.authorize_url" ,
" required" : false
} ,
{
" default" : " " ,
" key" : " token_url" ,
" kind" : " text" ,
" label" : " addons.sso.setting.token_url" ,
" required" : false
} ,
{
" default" : " " ,
" key" : " userinfo_url" ,
" kind" : " text" ,
" label" : " addons.sso.setting.userinfo_url" ,
" required" : false
} ,
{
" default" : " " ,
" key" : " scope" ,
" kind" : " text" ,
" label" : " addons.sso.setting.scope" ,
" required" : false
} ] ,
" version" : " 0.1.0" ,
" wasm" : " addon.wasm" } 
PeltyCMS