Getting Started with Spread Trader

Deployment

Spread Trader can be installed on client premises (Amazon, Equinix data centers) or as a cloud-hosted service in AWS. For cloud-hosted services, the process of installation and configuration of the system is straightforward:

1. You select a subscription plan that fits best your needs.
2. We set up the application on your AWS instance and send you an email with instructions for application usage and the supporting documentation.
3. A getting-started training session is arranged to show you around.

First Steps

1. Change admin password

After the installation of Spread Trader, the admin user is created with the default password. We recommend changing the default password.

To change the password:

1. Log in to the Keycloak Administration Console using the password KEYCLOAK_PASSWORD in the .env file or keycloak_password in the Terraform.
2. Navigate to Users to view the users list. The admin user is displayed in the list of users.
3. Click the admin user to manage it. On the Admin page, click the Credentials tab.
4. Click Reset password, type in the new password in the Password field, and repeat it in the Password Confirmation area. Set the Temporary selector to OFF and click Save to set the new password for the admin user.
5. As the admin user is created in Spread Trader during the installation, you can use this user with the new password to log in to Spread Trader.

2. Add new users

1. Log in to the Keycloak Administration Console using the password KEYCLOAK_PASSWORD in the .env file or keycloak_password in the Terraform.
2. Click Users to open the page with the list of users.
3. Click Add user. On the Create user page, specify the user information and click Create (field Username is mandatory).
4. In the Credentials tab, click Reset password, type in the new password in the Password field and repeat it in the Password Confirmation area. Set the Temporary selector to OFF and click Save to set the new password for the new user.

3. Configure 2FA (Optional)

For Two-Factor Authentication (2FA), Spread Trader uses One Time Password (OTP) functionality of the Keycloak application. OTP is an authentication method commonly used as part of two-factor identification (2FA) and multi-factor authentication (MFA). OTPs are unique passwords that are only valid for a single login session for a defined period of time.

Enforce new users to configure OTP

1. Open the Keycloak admin page and navigate to the Authentication tab.
2. In Required Actions, activate Enabled and Set as default action checkboxes for the Configure OTP action.

Enforce a user to configure OTP

1. Navigate to Users in the Keycloak admin panel.
2. Select the user and go to the Details tab.
3. In the Required user actions list, select Configure OTP.

Configure 2FA with the TOTP app

1. Complete one of the above sections - enforce to configure OTP for some users or all new users.
2. Log in to the Spread Trader application with the user that is forced to configure OTP.
3. The Mobile Authenticator Setup window appears.
4. Scan the QR code and fill in the one-time code.
5. Optionally, fill in the device name.

4. Configure trading instruments

Add and configure trading instrument(s) in Universe Configurator to start defining synthetic instruments in the Spread Trader application.

5. Create synthetic instruments

You are now all set to start creating synthetic instruments in the Spread Trader application.