Admin Guide

Synapse-GitHub Admin Guide

Configuration

Synapse-GitHub requires a GitHub API key. For information on how to sign up, please visit the GitHub API documentation.

Setting API key for global use

To set-up a global API key:

> github.setup.apikey myapikey
Setting GitHub API key for all users.

Using per-user API keys

A user may set-up their own API key:

> github.setup.apikey --self myapikey
Setting GitHub API key for the current user.

Dependencies

Synapse-GitHub does not have any dependencies.

Permissions

Package (synapse-github) defines the following permissions:
power-ups.github.user            : Controls user access to Synapse-GitHub. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.github.user
Added rule power-ups.github.user to user visi.

or:

> auth.role.addrule ninjas power-ups.github.user
Added rule power-ups.github.user to role ninjas.

Exported APIs

Synapse-GitHub does not currently export any APIs.

Workflows

Synapse-GitHub provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-GitHub provides the following node actions in Optic:

Name : github.issues.comments
Desc : Enrich it:dev:repo:issue nodes using Synapse-GitHub
Forms: it:dev:repo:issue

Name : github.issues.list
Desc : Enrich it:dev:repo nodes using Synapse-GitHub
Forms: it:dev:repo

Onload Events

Synapse-GitHub does not use any onload events.