Skip to content

Commit cee46f3

Browse files
committed
Add installation instructions for docker
Signed-off-by: Sayan Nandan <[email protected]>
1 parent f0ed769 commit cee46f3

File tree

1 file changed

+56
-4
lines changed

1 file changed

+56
-4
lines changed

docs/Getting-Started.md

Lines changed: 56 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Getting Started
22

33
<html>
4-
<img src="/img/runner_start.svg" style="height: 300px; width: 100%;">
4+
<img src="/img/runner_start.svg" style="height: 300px; width: 100%; ">
55
</html>
66
<br>
77
<br>
88

9-
Getting started with TerrabaseDB is easy 😊 (and fun!).</span>
9+
Getting started with TerrabaseDB is easy 😊 (and fun!). You can get started with [native binaries (recommended)](#get-started-with-bundles) or by using the [docker image](#get-started-with-docker).
1010

11-
## Steps
11+
## Get started with bundles
1212

1313
### Step 1: Download a bundle
1414

@@ -31,4 +31,56 @@ In the directory where you extracted the files, run `./tdb` on *nix systems or s
3131
`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!_.
3232
See all the available actions [here](/List-Of-Actions)
3333

34-
You're done with setting up `tdb` 🎉!
34+
You're done with setting up `tdb` 🎉!
35+
36+
## Get started with Docker
37+
38+
First of all, you need to have Docker installed and available on your `PATH` ; you can read the official guide [here](https://docs.docker.com/get-docker/). Once you've got Docker up and running, follow the steps!
39+
40+
### Step 0: Create a container
41+
42+
Open up a terminal and run:
43+
44+
```
45+
docker create terrabasedb/tdb --name tdbvm
46+
```
47+
48+
> **NOTE:** You may need superuser priveleges
49+
50+
At the same time, you'll need to set up the bundle by following [Step 1](#step-1-download-a-bundle) and [Step 2](#step-2-make-the-files-runnable) from the previous section.
51+
52+
### Step 1: Start the container
53+
54+
Now run:
55+
56+
```
57+
docker start tdbvm
58+
```
59+
60+
> **NOTE:** You may need superuser priveleges
61+
62+
### Step 2: Find the IP address of the container
63+
64+
In order to connect to the container (which, to `tsh` is nothing but a remote server), you'll have to run:
65+
66+
``` shell
67+
docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' tdbvm
68+
```
69+
70+
> **NOTE:** You may need superuser priveleges
71+
72+
And you'll get a result like:
73+
74+
``` text
75+
172.17.0.1
76+
```
77+
78+
### Step 3: Start the command line client
79+
80+
Open up a terminal in the directory where you downloaded the command line client and run:
81+
82+
``` shell
83+
tsh -h 172.17.0.1
84+
```
85+
86+
And you're done!

0 commit comments

Comments
 (0)