Getting Started Community Edition

Time required: 10 minutes

Overview

This getting started guide get Matatika Community Edition up and running on your local machine.

Requirements

Docker installed - How to get Docker
Git installed - How to get Git

Install the Matatika Community Edition

Go to https://github.com/Matatika/matatika-ce, clone the repository and use Docker Compose to run the application:

 git clone https://github.com/Matatika/matatika-ce
 cd matatika-ce

 # depending on the version of Docker you have installed, Docker Compose may not
 # exist as its own executable, but as a subcommand of `docker` instead - in this
 # case, you should substitute the below `docker-compose` with `docker compose`
 #
 # if you are using Docker Desktop for Linux, do not set `userID` or `groupID` as
 # this will interfere with the VM file sharing service (i.e. just run
 # `docker compose up`)
 userID=$(id -u) groupID=$(id -g) docker-compose up

Coffee time. This may take a few minutes to download the Docker images on the first run.

If you plan on hosting the lab for other users to connect to, we suggest setting your own secret in the docker-compose.yml using the environment variable MATATIKA_AUTH_LOCAL_SECRET.

Once everything is running, go to localhost:3443 in your browser, then login with your Matatika account or use the sign up link to create one.

No data will be stored in our cloud. Your Matatika account keeps your data safe with Auth0.
Create your first workspace. All configuration is managed as code in your workspaces directory:
```
 ls -al workspaces
```

Congratulations, you can now manage all your data with the Matatika Community Edition!

Make Your First API Call

Update

To update the Community Edition to the latest version, within the matatika-ce directory, run

git pull

If a new version has been released, this will bring in upstream changes to the docker-compose.yml file referencing new image tags. Check here for new releases.

Specific version

To update (or rollback) to a specific release version, within the matatika-ce directory, run

git checkout main
git pull
git checkout <RELEASE TAG>
# e.g. `git checkout 10244` for https://github.com/Matatika/matatika-ce/releases/tag/10244

To find what release tags are available, check here, or run

git tag --list

Specify a Custom Auth0 Identity Provider

If you want to use your own company login from within the UI, the Community Edition can be configured to use a custom Auth0 identity provider. This will replace Matatika as the default identity provider responsible for login and user authentication.

Create a new Single Page Web Application
Click Settings and add
```
 https://localhost:3443
```
to Allowed Callback URLs, Allowed Logout URLs and Allowed Web Origins

Export the following environment variables:

 # your tenant domain ("Settings" > "Basic Information" > "Domain")
 export APP_IDENTITY_DOMAIN=

 # your client ID ("Settings" > "Basic Information" > "Client ID")
 export APP_IDENTITY_CLIENT_ID=

 # your client database connection name ("Connections" > "Database")
 export APP_IDENTITY_CONNECTION=

 # your tenant identity provider settings (run once `APP_IDENTITY_DOMAIN` is set
 # - do not modify)
 export CATALOG_AUTH_IDPS_PRIMARY_ISSUER_URI=https://$APP_IDENTITY_DOMAIN/
 export CATALOG_AUTH_IDPS_PRIMARY_JWK_SET_URI=https://$APP_IDENTITY_DOMAIN/.well-known/jwks.json

 # optional secondary tenant identity provider settings
 # export CATALOG_AUTH_IDPS_SECONDARY_ISSUER_URI=
 # export CATALOG_AUTH_IDPS_SECONDARY_JWK_SET_URI=

Run the application:

 # depending on the version of Docker you have installed, Docker Compose may not
 # exist as its own executable, but as a subcommand of `docker` instead - in this
 # case, you should substitute the below `docker-compose` with `docker compose`
 #
 # if you are using Docker Desktop for Linux, do not set `userID` or `groupID` as
 # this will interfere with the VM file sharing service (i.e. just run
 # `docker compose up`)
 userID=$(id -u) groupID=$(id -g) docker-compose up