Skip to content

Commit f061a5d

Browse files
committed
Fix docker installation guide
1 parent fb80971 commit f061a5d

File tree

3 files changed

+30
-39
lines changed

3 files changed

+30
-39
lines changed

docs/16.building-from-source.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,52 @@
22
id: building-from-source
33
title: Building from source
44
---
5+
56
Of course you can build it from source — but with quite a bit of hassle. The database server is a bit fussy with its builds, so you'll need quite a few tools before you can actually start using it.
67

78
### Step 1: Install pre-requisites
9+
810
As Skytable is written in Rust, you'll have to install the Rust toolchain to build it (a little messy, but not too messy). Go to [this page](https://rustup.rs/) to set up Rust on your local machine.
911

1012
Besides, the TLS/SSL components are written in C (OpenSSL) — so you'll need to install:
11-
* A C compiler for your platform
12-
* GNU Make (`make`)
13-
* Perl
13+
14+
- A C compiler for your platform
15+
- GNU Make (`make`)
16+
- Perl
1417

1518
### Step 2: Clone the tag
19+
1620
Run this from your terminal:
21+
1722
```
18-
git clone --branch v0.6.3 https://github.com/skytable/skytable.git
23+
git clone --branch v0.7.0 https://github.com/skytable/skytable.git
1924
```
25+
2026
:::tip Bonus tip
2127
If you want to avoid downloading all the version history, run this instead:
28+
2229
```
23-
git clone --depth 1 --branch v0.6.3 https://github.com/skytable/skytable.git
30+
git clone --depth 1 --branch v0.7.0 https://github.com/skytable/skytable.git
2431
```
32+
2533
:::
34+
2635
### Step 3: Build it!
36+
2737
Expecting that you're still in the same directory, run:
38+
2839
```
2940
cd skybase && cargo build --release
3041
```
42+
3143
:::note
3244
This will take **crazy long** at times, so hold on until Cargo finishes building things
3345
:::
3446

3547
### Step 4: Get the binaries
48+
3649
You'll need to copy `skyd` and `skysh` (or `skyd.exe` and `skysh.exe` if on Windows) from the `skybase/target/release` folder. Be sure to copy these **exact files** and not something else!
50+
3751
### Step 5: Run it!
38-
Now start the database server by running `./skyd` and then start the interactive shell by running `./skysh`. You're ready to use the [actions](actions-overview)!
52+
53+
Now start the database server by running `./skyd` and then start the interactive shell by running `./skysh`. You're ready to use the [actions](actions-overview)!

docs/2.getting-started.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Getting started with Skytable is easy 😊 (and fun!). You can get started with
99

1010
### Step 1: Download a bundle
1111

12-
Head over to this [page](https://github.com/skytable/skytable/releases/v0.6.3) and download a version for your platform.
12+
Head over to this [page](https://github.com/skytable/skytable/releases/v0.7.0) and download a version for your platform.
1313

1414
### Step 2: Make the files runnable
1515

@@ -29,32 +29,20 @@ You're done with setting up `skyd` 🎉!
2929

3030
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!
3131

32-
### Step 0: Create a container
32+
### Step 0: Start the container
3333

3434
Open up a terminal and run:
3535

3636
```
37-
docker create skytable/sdb:v0.6.3 --name skyvm
37+
docker run -d --name skyvm skytable/sdb:v0.7.0
3838
```
3939

4040
:::note
4141
You may need superuser privileges
4242
:::
4343
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.
4444

45-
### Step 1: Start the container
46-
47-
Now run:
48-
49-
```
50-
docker start skyvm
51-
```
52-
53-
:::note
54-
You may need superuser privileges
55-
:::
56-
57-
### Step 2: Find the IP address of the container
45+
### Step 1: Find the IP address of the container
5846

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

@@ -71,7 +59,7 @@ And you'll get a result like:
7159
172.17.0.1
7260
```
7361

74-
### Step 3: Start the command line client
62+
### Step 2: Start the command line client
7563

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

versioned_docs/version-0.7.0/2.getting-started.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,32 +29,20 @@ You're done with setting up `skyd` 🎉!
2929

3030
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!
3131

32-
### Step 0: Create a container
32+
### Step 0: Start the container
3333

3434
Open up a terminal and run:
3535

3636
```
37-
docker create skytable/sdb:v0.7.0 --name skyvm
37+
docker run -d --name skyvm skytable/sdb:v0.7.0
3838
```
3939

4040
:::note
4141
You may need superuser privileges
4242
:::
4343
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.
4444

45-
### Step 1: Start the container
46-
47-
Now run:
48-
49-
```
50-
docker start skyvm
51-
```
52-
53-
:::note
54-
You may need superuser privileges
55-
:::
56-
57-
### Step 2: Find the IP address of the container
45+
### Step 1: Find the IP address of the container
5846

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

@@ -71,7 +59,7 @@ And you'll get a result like:
7159
172.17.0.1
7260
```
7361

74-
### Step 3: Start the command line client
62+
### Step 2: Start the command line client
7563

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

0 commit comments

Comments
 (0)