Getting started with Skytable 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.
If you're on Debian, consider downloading an appropriate
.deb (Debian Package) file for your machine.
The package will install
sky-migrate on your system while also
systemd service unit.
Step 2: Make the files runnable
zip file that you just downloaded. If you're on a *nix system, run
chmod +x skyd skysh to make the files executable. If you're on Windows, right-click the files and then check the
UNBLOCK checkbox and click on the
Step 3: Start the database server
In the directory where you extracted the files, run
./skyd on *nix systems or simply
skyd on Windows systems. That's all there is to starting the database server!
Step 4: Run the shell
skysh 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!.
You're done with setting up
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!
You may need superuser privileges for installation and running the commands below.
Also, please note that commands like
skyd are used expecting them to be in your shell's
if they aren't, simply use the path to where you have the binaries.
Step 0: Create and start the container
We'll create a container where:
- We'll call our container
- We'll expose port 2003 of the container
- We'll save all our data on the host in a folder called
skytablerelative to the current directory. To achieve this, we'll make use of Docker volumes.
Open up a terminal and run:
docker run --name mysky \
-v skytable:/var/lib/skytable \
-p 2003:2003 \
Step 1: Download and setup the bundle
Follow the instructions above so that you're ready to run
Step 2: Connect to the instance
skysh -h 127.0.0.1 -p 2003
Now, you're all set!