Skip to main content
Version: 0.4.5

Getting Started

Getting started with TerrabaseDB is easy ๐Ÿ˜Š (and fun!). You can get started with native binaries (recommended) or by using the docker image.

Get started with bundles#

Step 1: Download a bundle#

Head over to this page and download a version for your platform.

Step 2: Make the files runnable#

Unzip the zip file that you just downloaded. If you're on a *nix system, run chmod +x tdb tsh to make the files executable. If you're on Windows, right-click the files and then check the UNBLOCK checkbox and click on the APPLY button.

Step 3: Start the database server#

In the directory where you extracted the files, run ./tdb on *nix systems or simply tdb on Windows systems. That's all there is to starting the database server!

Step 4: Run the shell tsh#

tsh is the shell that is shipped with the bundle. Run it, just like you did with the database server. Now enter commands in the shell, and have fun! First run HEYA to check if everything is fine - the server should reply with HEY!. See all the available actions here

You're done with setting up tdb ๐ŸŽ‰!

Get started with Docker#

First of all, you need to have Docker installed and available on your PATH ; you can read the official guide here. Once you've got Docker up and running, follow the steps!

Step 0: Create a container#

Open up a terminal and run:

docker create terrabasedb/tdb:v0.4.5 --name tdbvm

You may need superuser privileges

At the same time, you'll need to set up the bundle by following Step 1 and Step 2 from the previous section.

Step 1: Start the container#

Now run:

docker start tdbvm

You may need superuser privileges

Step 2: Find the IP address of the container#

In order to connect to the container (which, to tsh is nothing but a remote server), you'll have to run:

docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' tdbvm

You may need superuser privileges

And you'll get a result like:

Step 3: Start the command line client#

Open up a terminal in the directory where you downloaded the command line client and run:

tsh -h

And you're done!