Skip to main content
The back office is an optional, installable business tool. TRDRS hosts the engine and trading state; your installation hosts the business UI and its small server. Your own backend can use the same Venue API without installing this tool.

Before you start

  1. Sign in to sandbox API access.
  2. Create or select your venue and create a Venue key. For every operation in the tool, select venue:read, venue:configure, account:read, account:issue, risk:halt, provider:manage, connection:manage and stage:advance. A read-only installation can use just venue:read and account:read; writes then return 403.
  3. Save the venue ID and keep the secret in your server environment.
  4. Prove the key with the business quickstart.
Use a separate key for each installation so it can be revoked independently. Keys, owners and venue creation remain in your TRDRS profile. The installed tool links there for those actions.

Install version 0.1.0

Use Node.js 22 or newer. Start in a new directory so installation cannot overwrite an existing project:
The password prompt does not echo what you type. Store the printed password hash in .env as TRDRS_BACKOFFICE_PASSWORD_HASH. Do not put a password in a shell command or source control. On Linux, sha256sum -c can replace shasum -a 256 -c. Stop if checksum verification fails. Edit .env with the venue ID and key from your TRDRS profile:
TRDRS_SECURE_COOKIE=false is for this loopback HTTP check only. For a deployment, serve the tool through HTTPS and set it to true.
Open http://127.0.0.1:8787 and sign in with the operator username and password you just configured. This operator login belongs to your installation; traders continue to sign in to TRDRS. No package registry account or access to the private TRDRS repository is required to run the bundle.

Run in a container

The archive contains a Dockerfile and .dockerignore that excludes local credentials. Build from the extracted directory and provide secrets only when starting the container:
For a hosted installation, configure HTTPS at your reverse proxy, keep the server private behind it, set TRDRS_PUBLIC_ORIGIN to that exact external HTTPS origin, and use your deployment service’s secret store. Do not copy .env into an image. Version 0.1.0 requires the September 21, 2026 Venue API, including branding with expectedUpdatedAt and the instrument reference endpoint. The archive’s COMPATIBILITY.md, TERMS.md and third-party notices travel with each release. The internal TRDRS UI packages are not separate public packages; the runnable tool includes their compiled components.

What runs where

The browser never receives the Venue key. An operator signs in to the back-office server, which accepts only its configured venue and allowed operations. It is not a general proxy to the engine.

Verify your installation

Before using write actions, check that the displayed venue and environment match the key you configured. Read its accounts, including Existing accounts with Original rules. Reading those accounts does not assign a group, change a balance or alter trading rules. For write tests, create a dedicated sandbox setup and follow the business workflow. Confirm branding, configuration and accounts through the API and trader view before relying on them. A saved provider declaration does not prove real provider execution.

Operating it

  • Keep the app behind HTTPS when it is reachable beyond your local machine.
  • Protect operator access and the server environment; a Venue key is authority over your venue.
  • Rotate a key in the TRDRS profile, update the server secret and restart the tool. Revoking an old key invalidates its next engine request; restarting must not bring the old key back.
  • Keep sandbox and production installations separate. Production needs an explicit production base URL and matching key. Switching endpoints copies no accounts or balances.
  • Pin the tool version and test upgrades in sandbox. Back up deployment configuration without putting credentials in source control.
The hosted sandbox back office remains available during migration. It is not required for direct API access.