FlowsBook a callSign inCreate free accountSign up
Your own network

The xMap runner

A small program you install on a computer inside your network. Your flows can then read your private databases and call your internal addresses, without opening anything to the internet.

Only calls out

Nothing listens inside your network. The runner asks xMap Flows for work over HTTPS, does it there, and sends the answer back.

Reads, and only what you allow

Database reads run in a read-only transaction. It writes only for Save to my database, on a connection an admin allowed to write.

Keeps nothing

No data is stored on the computer it runs on. Revoke its token in Settings and it stops at once.

1. Add a runner

In xMap Flows, an organization admin opens Settings, Advanced, Runners in your network, and presses Add a runner. Give it a name, such as Office or Data centre. Copy its token (it starts with xfr_): it is shown once.

2. Start it on a computer in your network

Pick a computer or server that can reach your database or internal address, and can reach https://flows.xmap.ai on port 443. It needs no address of its own and no open port.

With Node.js (version 20 or newer)

curl -O https://flows.xmap.ai/runner/xmap-runner.mjs
npm install pg
node xmap-runner.mjs --token xfr_your_token

The token can also be given as the environment variable XMAP_RUNNER_TOKEN. Install mysql2 or mssql beside it for MySQL or SQL Server reads.

With Docker

Save this as Dockerfile next to xmap-runner.mjs:

FROM node:20-alpine
WORKDIR /runner
RUN npm install pg@8
COPY xmap-runner.mjs .
USER node
CMD ["node", "xmap-runner.mjs"]

Then build and start it:

docker build -t xmap-runner .
docker run -d --restart unless-stopped --name xmap-runner -e XMAP_RUNNER_TOKEN=xfr_your_token xmap-runner

When it starts, Settings shows the runner as Connected, with its computer's name.

3. Point a connection at it

On the Connections page, add or edit a team PostgreSQL connection or API sign-in, set Reach it through to A runner in your network and pick the runner. Its address may now be a private one, such as 10.0.0.5 or db.internal. Press Test: the test goes through the runner too.

Database query, Database lookup, Save to my database, the HTTP block (with that API sign-in) and Send to an API then use it. A flow waits for the runner's answer for up to a minute; if the runner is not running, the block says so in words.

Options

Security

The runner is one file you can read before you run it: xmap-runner.mjs.