|
2 | 2 | id: building-from-source |
3 | 3 | title: Building from source |
4 | 4 | --- |
| 5 | + |
5 | 6 | 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. |
6 | 7 |
|
7 | 8 | ### Step 1: Install pre-requisites |
| 9 | + |
8 | 10 | 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. |
9 | 11 |
|
10 | 12 | 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 |
14 | 17 |
|
15 | 18 | ### Step 2: Clone the tag |
| 19 | + |
16 | 20 | Run this from your terminal: |
| 21 | + |
17 | 22 | ``` |
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 |
19 | 24 | ``` |
| 25 | + |
20 | 26 | :::tip Bonus tip |
21 | 27 | If you want to avoid downloading all the version history, run this instead: |
| 28 | + |
22 | 29 | ``` |
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 |
24 | 31 | ``` |
| 32 | + |
25 | 33 | ::: |
| 34 | + |
26 | 35 | ### Step 3: Build it! |
| 36 | + |
27 | 37 | Expecting that you're still in the same directory, run: |
| 38 | + |
28 | 39 | ``` |
29 | 40 | cd skybase && cargo build --release |
30 | 41 | ``` |
| 42 | + |
31 | 43 | :::note |
32 | 44 | This will take **crazy long** at times, so hold on until Cargo finishes building things |
33 | 45 | ::: |
34 | 46 |
|
35 | 47 | ### Step 4: Get the binaries |
| 48 | + |
36 | 49 | 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 | + |
37 | 51 | ### 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)! |
0 commit comments