Quick Start

Prerequisite Software

Ensure the following software is installed before proceeding:

• Docker
• Docker Compose

Step 1: Download the docker-compose file

The repository mlcraft-io/mlcraft/install-manifests houses all the necessary installation manifests for deploying Synmetrix anywhere. You can download the docker compose file from this repository:

Execute this in a new directory

Using wget

wget https://raw.githubusercontent.com/mlcraft-io/mlcraft/main/install-manifests/docker-compose/docker-compose.yml

Using curl

curl https://raw.githubusercontent.com/mlcraft-io/mlcraft/main/install-manifests/docker-compose/docker-compose.yml -o docker-compose.yml

Step 2: Launch Synmetrix

Execute the following command to start Synmetrix along with a Postgres database for data storage.

$ docker-compose pull stack && docker-compose up -d

Verify if the containers are operational:

$ docker ps

CONTAINER ID IMAGE                 ... CREATED STATUS PORTS          ...
c8f342d086f3 synmetrix/stack       ... 1m ago  Up 1m  80->8888/tcp ...
30ea14ddaa5e postgres:12           ... 1m ago  Up 1m  5432/tcp    

The installation of all dependencies will take approximately 5-7 minutes. Wait until you see the Synmetrix Stack is ready message. You can view the logs using docker-compose logs -f to confirm if the process has completed.

Step 3: Explore Synmetrix

• You can access Synmetrix at http://localhost/

• The GraphQL endpoint is located at http://localhost/v1/graphql

• The Admin Console (Hasura Console) can be found at http://localhost/console

• The Cube Swagger API can be found at http://localhost:4000/docs

note

1. Admin Console Access: Ensure to check HASURA_GRAPHQL_ADMIN_SECRET in the docker-compose file. This is mandatory for accessing the Admin Console. The default value is adminsecret. Remember to modify this in a production environment.

2. Environment Variables: Set up all necessary environment variables. Synmetrix will function with the default values, but certain features might not perform as anticipated.

3. Preloaded Seed Data: The project is equipped with preloaded seed data. Use the credentials below to sign in:

   • Email: demo@synmetrix.org
   • Password: demodemo

   This account is pre-configured with two demo datasources and their respective SQL API access. For SQL operations, you can use the following credentials with any PostgreSQL client tool such as DBeaver or TablePlus:

   Host	Port	Database	User	Password
   localhost	15432	db	demo_pg_user	demo_pg_pass
   localhost	15432	db	demo_clickhouse_user	demo_clickhouse_pass

If you need assistance or want to schedule a 30-minute call with our team to help you get set up, please select a time directly here.

Demo online

Demo: app.synmetrix.org

• Login: demo@synmetrix.org
• Password: demodemo

Demo datasource credentials

Database type	Host	Port	Database	User	Password	SSL
ClickHouse	gh-api.clickhouse.tech	443	default	play	no password	true
PostgreSQL	demo-db-examples.cube.dev	5432	ecom	cube	12345	false