Quick Start
To begin working locally with the replay server, do the following:
- Set up your environment to be able to pull from private Go modules as indicated
here
- (Optional) Create SSL certificates
- If serving from
localhost these can be created via this Confluence document
- If serving from
*.quantummetric.com, obtain the Quantum Metric certs from the Deployment repo
- NB: The
certs/ directory in this repository is git-ignored.
- Create a
.env file and add to it the following contents:
IAM.CLIENTID={CLIENT_ID_HERE}
IAM.CLIENTSECRET={CLIENT_SECRET_HERE}
CERTS.CRT={LOCATION_TO_CERT}
CERTS.KEY={LOCATION_TO_KEY}
If CERTS are not specified, plain HTTP will be used. The client id and secret must have access to Config Service. Generally for development, profiles.dev.clientId and profiles.dev.clientSecret from your ~/.config/qm-iam/credentials.json file can be used here.
- Ensure the server can boot up and load on HTTPS (if you specified
CERTS) using the command make dev-server.
- If the server boots up correctly and runs the database migrations, download
pgAdmin4 and connect it to the local Postgres database using
the relevant values from config-local.yml's database object.
- If a change needs to be made to the database schema, it must be done as a migration and a convenience tool for doing that is install the tool
golang-migrate
(as described in database.md).
