Admin Guide

Synapse-Spur Admin Guide

Configuration

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

Setting API key for global use

To set-up a global API key:

> spur.setup.apikey myapikey
Setting Spur API key for all users.

Using per-user API keys

A user may set-up their own API key:

> spur.setup.apikey --self myapikey
Setting Spur API key for the current user.

Setting a tag prefix for global use

Note: If not set, this will default to rep.spur.

> spur.setup.tagprefix my.prefix
Setting Synapse-Spur tag prefix to my.prefix.

Permissions

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

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

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

or:

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

Workflows

Synapse-Spur provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-Spur provides the following node actions in Optic:

Name : ipcontext
Desc : Query the Spur API for IP context data.
Forms: inet:ipv4, inet:ipv6

Onload Events

Synapse-Spur uses an onload event to create the following extended properties:

_spur:organization (The organization operating this IP.)
_spur:infrastructure (The primary type of infrastructure this IP supports.)
_spur:client:count (The average number of clients Spur observes daily on this IP.)
_spur:client:spread (The total geographic area (in square kilometers) where Spur has observed users for this IP.)
_spur:client:countries (The number of countries where Spur has observed clients in for this IP.)
_spur:client:concentration:loc (The strongest location where Spur has observed clients using this IP.)
_spur:client:concentration:density (The percentage of clients on this IP observed in the concentrated location, versus other locations.)
_spur:client:concentration:skew (The straight line distance from the top level IP location.)
_spur:client:concentration:geohash (The geohash of the concentration area.)