Admin Guide

Synapse-Tor Admin Guide

Configuration

Synapse-Tor does not require an API key. When the Power-Up is installed, a global configuration named default is created with the default settings, so tor.sync runs without further setup. On upgrade, a tag prefix previously set with tor.setup.tagprefix is migrated to the default configuration. The default configuration is not created if a Synapse-Tor configuration already exists.

Setting the configuration for global use

Only one global configuration may exist at a time, so replacing it requires deleting the existing one first:

> tor.config.del default
Synapse-Tor config "default" deleted

> tor.config.add global_config
Synapse-Tor config "global_config" added

Creating a configuration for role-based use

Add an unscoped configuration:

> tor.config.add myunscoped --scope unscoped
Synapse-Tor config "myunscoped" added

Grant another user admin permissions to the new configuration:

> tor.config.update myunscoped --perm user visi admin
Updated Synapse-Tor config "myunscoped"

Grant a role read permissions to the new configuration:

> tor.config.update myunscoped --perm role ninjas read
Updated Synapse-Tor config "myunscoped"

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.tor.admin or storm.lib.inet.http.proxy permission.

When the proxy configuration is set to (false) or a URL the permission will be checked when a configuration is created/updated, and when it is used to make an HTTP request.

Permissions

Package (synapse-tor) defines the following permissions:
power-ups.tor.user               : Controls user access to Synapse-Tor. ( default: false )
power-ups.tor.admin              : Controls admin access to Synapse-Tor, including managing configuration. ( default: false )

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

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

or:

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

Exported APIs

Synapse-Tor does not currently export any APIs.

Workflows

Synapse-Tor provides the following workflows in Optic:

Title: Configuration

The Configuration workflow may be used to manage Synapse-Tor configurations from Optic.