tigris

README

Tigris Data

Getting started

These instructions will get you through setting up Tigris Data locally as Docker containers.

Prerequisites

• Make sure that you have Docker and Docker Compose installed
  • Windows or MacOS: Install Docker Desktop
  • Linux: Install Docker and then Docker Compose

Running locally

The docker/local directory contains the docker-compose.yaml which describes the configuration of Tigris Data components. You can run Tigris Data in a local environment by executing:

cd docker/local
docker-compose up -d

Connecting using CLI

Install the CLI:

go install github.com/tigrisdata/tigris-cli@latest

Make sure to include the installed binary in your PATH.

Test that Tigris is up and running locally:

export TIGRIS_URL=http://localhost:8081
tigris-cli db list databases

More elaborate example of CLI usage can be found here.

Golang client example can be found here.

Documentation

• Development Overview
• Testing
• Configuration
• Deployment to Kubernetes

Roadmap

• Alpha Release

Community & Support

• Slack Community
• GitHub Issues
• GitHub Discussions

License

This software is licensed under the Apache 2.0.