From f061a5d8f4a1053870a8a3e3e75ee242440e5bdd Mon Sep 17 00:00:00 2001 From: Sayan Nandan Date: Fri, 20 Aug 2021 05:10:18 -0700 Subject: [PATCH] Fix docker installation guide --- docs/16.building-from-source.md | 27 ++++++++++++++----- docs/2.getting-started.md | 22 ++++----------- .../version-0.7.0/2.getting-started.md | 20 +++----------- 3 files changed, 30 insertions(+), 39 deletions(-) diff --git a/docs/16.building-from-source.md b/docs/16.building-from-source.md index c9c0e1c58..85521eb22 100644 --- a/docs/16.building-from-source.md +++ b/docs/16.building-from-source.md @@ -2,37 +2,52 @@ id: building-from-source title: Building from source --- + 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. ### Step 1: Install pre-requisites + 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. Besides, the TLS/SSL components are written in C (OpenSSL) — so you'll need to install: -* A C compiler for your platform -* GNU Make (`make`) -* Perl + +- A C compiler for your platform +- GNU Make (`make`) +- Perl ### Step 2: Clone the tag + Run this from your terminal: + ``` -git clone --branch v0.6.3 https://github.com/skytable/skytable.git +git clone --branch v0.7.0 https://github.com/skytable/skytable.git ``` + :::tip Bonus tip If you want to avoid downloading all the version history, run this instead: + ``` -git clone --depth 1 --branch v0.6.3 https://github.com/skytable/skytable.git +git clone --depth 1 --branch v0.7.0 https://github.com/skytable/skytable.git ``` + ::: + ### Step 3: Build it! + Expecting that you're still in the same directory, run: + ``` cd skybase && cargo build --release ``` + :::note This will take **crazy long** at times, so hold on until Cargo finishes building things ::: ### Step 4: Get the binaries + 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! + ### Step 5: Run it! -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)! \ No newline at end of file + +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)! diff --git a/docs/2.getting-started.md b/docs/2.getting-started.md index 1c46a5635..821632b7e 100644 --- a/docs/2.getting-started.md +++ b/docs/2.getting-started.md @@ -9,7 +9,7 @@ Getting started with Skytable is easy 😊 (and fun!). You can get started with ### Step 1: Download a bundle -Head over to this [page](https://github.com/skytable/skytable/releases/v0.6.3) and download a version for your platform. +Head over to this [page](https://github.com/skytable/skytable/releases/v0.7.0) and download a version for your platform. ### Step 2: Make the files runnable @@ -29,12 +29,12 @@ You're done with setting up `skyd` 🎉! 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! -### Step 0: Create a container +### Step 0: Start the container Open up a terminal and run: ``` -docker create skytable/sdb:v0.6.3 --name skyvm +docker run -d --name skyvm skytable/sdb:v0.7.0 ``` :::note @@ -42,19 +42,7 @@ You may need superuser privileges ::: 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. -### Step 1: Start the container - -Now run: - -``` -docker start skyvm -``` - -:::note -You may need superuser privileges -::: - -### Step 2: Find the IP address of the container +### Step 1: Find the IP address of the container In order to connect to the container (which, to `skysh` is nothing but a remote server), you'll have to run: @@ -71,7 +59,7 @@ And you'll get a result like: 172.17.0.1 ``` -### Step 3: Start the command line client +### Step 2: Start the command line client Open up a terminal in the directory where you downloaded the command line client and run: diff --git a/versioned_docs/version-0.7.0/2.getting-started.md b/versioned_docs/version-0.7.0/2.getting-started.md index aa19a2605..821632b7e 100644 --- a/versioned_docs/version-0.7.0/2.getting-started.md +++ b/versioned_docs/version-0.7.0/2.getting-started.md @@ -29,12 +29,12 @@ You're done with setting up `skyd` 🎉! 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! -### Step 0: Create a container +### Step 0: Start the container Open up a terminal and run: ``` -docker create skytable/sdb:v0.7.0 --name skyvm +docker run -d --name skyvm skytable/sdb:v0.7.0 ``` :::note @@ -42,19 +42,7 @@ You may need superuser privileges ::: 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. -### Step 1: Start the container - -Now run: - -``` -docker start skyvm -``` - -:::note -You may need superuser privileges -::: - -### Step 2: Find the IP address of the container +### Step 1: Find the IP address of the container In order to connect to the container (which, to `skysh` is nothing but a remote server), you'll have to run: @@ -71,7 +59,7 @@ And you'll get a result like: 172.17.0.1 ``` -### Step 3: Start the command line client +### Step 2: Start the command line client Open up a terminal in the directory where you downloaded the command line client and run: