Admin Guide

Synapse-Google Search Admin Guide

Configuration

Synapse-Google Search requires a Google Search API key and CX key for performing the searches using the /customsearch API endpoint.

For information on how to sign up for these keys, please visit the Google Search API documentation.

Setting API key for global use

To set-up a global API and CX key:

> google.search.setup.apikey myapikey
Setting Synapse-Google Search API key for all users.

> google.search.setup.cx mycxkey
Setting Synapse-Google Search CX key for all users.

Using per-user API keys

A user may set-up their own API key:

> google.search.setup.apikey --self myapikey
Setting Synapse-Google Search API key for the current user.

> google.search.setup.cx --self mycxkey
Setting Synapse-Google Search CX key for the current user.

Permissions

Package (synapse-google-search) defines the following permissions:
power-ups.google-search.user     : Controls user access to Synapse-Google Search. ( default: false )

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

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

or:

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

Exported APIs

Synapse-Google Search does not currently export any APIs.

Node Actions

Synapse-Google Search provides the following node actions in Optic:

Name : google.search.enrich
Desc : Enrich nodes using Synapse-Google Search. This enriches nodes based on their primary property.
Forms: Any

Onload Events

Synapse-Google Search does not use any onload events.