Getting started

openoms is a single oms binary: the server, the web cockpit and the command-line tool in one file. Follow the steps to go from installation to running managing the openoms cockpit.

1. Install

Install oms as described on Installation, then come back here.

2. Set up

Run the following command to setup openoms for the first time.

oms init

The program will prompt you to answer some basic questions on

• whether to use your own PostgresSQL (16.0) database or whether you would like to use the pre-configured docker image
• which administrator password you would like to set for the admin cockpit ui
• which port the oms should listen on for requests

Then it writes ~/.config/oms/oms.toml (mode 0600), creates the database, applies every migration and loads reference data (currencies, ~2,800 venues, trading calendars).

Back up oms.toml

The master key in oms.toml is the only thing that can decrypt the broker credentials you store later. Lose it and they are gone. See Master key and backups.

TODO: Come up with better system than master key.

There a couple of commands that let you work and setup the database for this application (see) To upgrade an existing database, use oms database migrate — with a Docker database, see Updating for where its superuser password lives.

3. Start

oms

It logs what it found and listens where you told it. On a fresh install, expect a note that the instrument catalog is empty — the cockpit fills it in the next guide.

4. Open the cockpit

Open http://localhost:3001/cockpit/ and log in with your admin password. On a remote server, tunnel the port first:

ssh -L 3001:localhost:3001 your-server

Forgot a generated password? It is admin_password in ~/.config/oms/oms.toml.

Next: your first paper trade

Updating

oms update

See Installation and Updating.