Reach databases and addresses inside your network
Install the xMap runner inside your network so flows can read private databases and call internal addresses.
By the xMap team · Updated
Your database or internal API is not on the internet? The xMap runner is a small program you install on a computer inside your network. It only calls out to xMap Flows over HTTPS: nothing in your network has to be opened, and it keeps no data.
- An organization admin opens Settings, Advanced, Runners in your network, and presses Add a runner. Copy its token: it is shown once.
- On a computer that can reach your database or internal address, start it with Node.js 20 or newer, or with Docker. The steps are on the runner page. Settings then shows it as Connected.
- 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 be a private one, such as 10.0.0.5 or db.internal. Press Test: it goes through the runner.
Database query, Database lookup, Save to my database, the HTTP block and Send to an API then use it. Reads run in a read-only transaction, checked again by the runner; Save to my database writes only when the connection allows writing. An API sign-in is sent only to its own server address, and an internal address that needs no sign-in can use the method No sign-in.
- Only team connections can use a runner, so admins decide what it reaches.
- If the runner is not running, the block says so in words.
- Revoke a runner in Settings and it stops at once.
- Only PostgreSQL databases can be reached this way today.