Admin Guide

Synapse-Nominatim Admin Guide

Configuration

Synapse-Nominatim requires a Nominatim endpoint. For information on how to host your own instance, please visit the Nominatim wiki page.

Adding a Synapse-Nominatim API for global use

To add a global Nominatim API endpoint:

> nominatim.config.add myglobal "https://nominatim.openstreetmap.org"
Synapse-Nominatim config "myglobal" added

Add a Synapse-Nominatim API for role based use

To add an unscoped Nominatim API endpoint for role based use:

> nominatim.config.add myunscoped https://anotherendpoint:10089 --scope unscoped
Synapse-Nominatim config "myunscoped" added

Grant another user admin permissions on the unscoped configuration:

> nominatim.config.update --perm user visi admin myunscoped
Updated Synapse-Nominatim config "myunscoped"

Grant a role permissions to this unscoped configuration:

> nominatim.config.update myunscoped --perm role ninjas read
Updated Synapse-Nominatim config "myunscoped"

Setting a Proxy server for global use

To set a proxy for the global Nominatim API endpoint:

> nominatim.config.update --proxy socks5://mysocksproxy:1234 myglobal
Updated Synapse-Nominatim config "myglobal"

Removing the proxy server

To remove the proxy settings for the global Nominatim API endpoint:

> nominatim.config.update --proxy $lib.false myglobal
Updated Synapse-Nominatim config "myglobal"

Dependencies

Synapse-Nominatim does not have any dependencies.

Permissions

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

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

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

or:

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

Node Actions

Synapse-Nominatim provides the following node actions in Optic:

Name : enrich
Desc : Enrich nodes using Synapse-Nominatim
Forms: geo:nloc, geo:place, inet:ipv4, inet:ipv6, inet:web:acct, inet:web:group, inet:wifi:ap, it:host, tel:mob:cell, tel:mob:telem

Onload Events

Synapse-Nominatim does not use any onload events.