The process of installing piladb might differ depending on your role and purposes.
Before installing piladb, please consider that it was designed and developed from Linux for Linux. Although, compatibility and first class support for Mac is guaranteed, and it will stay like this forever. Said this, piladb should work on platforms like Windows or *BSD too, yet there's not official support as of now.
For users 🙋
As a user of piladb you only need a HTTP client that makes it possible to interact with the REST API of the database server,
pilad. This a list of some of the most popular HTTP clients out there:
- Command line interface:
- Graphical user interface:
- Programming languages: Every language should have a solid HTTP client that lets you interact programatically with piladb. A simple web search should point you into the right direction. For example, HTTP clients for Ruby.
For admins 💻
As an admin, you want to manage
pilad, the piladb server. In order to do that, you can choose one of the following approaches:
tarcommand line tools.
All official piladb releases are hosted on Github. Find the latest release for your platform and architecture in the Downloads list at the releases page. They are available on
tar -zxvf piladbX.Y.Z.OS-ARCH.tar.gz
When you uncompress the file, you will find inside the resulting directory a
pilad binary file. Move the binary file where you want to execute it from. For more about
pilad usage, go to the next page.
You can install piladb with
piladb.sh, a shell script that exports a few utilities around the project for the command line and shell scripts. One of these utilities is
piladb_download, a command that will download a Release, uncompress it and put the
pilad binary in place. You can source these commands with a single action, with no need to download the script:
# export piladb.sh utilities source <(curl -s https://raw.githubusercontent.com/oscillatingworks/piladb-sh/master/piladb.sh) # download and install pilad binary # $version is a released version, e.g. 0.1.0, 0.1.1, etc. # $os is the operating system, e.g. linux or darwin # if parameters are not provided, it will install latest release for linux piladb_download $version $os # check pilad was installed pilad -h
Keep in mind that
piladb_download command will store the
pilad binary into
$HOME/bin, and will add this directory to
gitand Go +1.6 installed, and
Download and install the project with:
go get -u github.com/fern4lvarez/piladb/...
You will find the
pilad binary file into
$GOPATH/bin with the right permissions and full compatibility with the host.
Requirements: Docker installed.
You can execute
pilad from a Docker container, so you don't to install or depend on Go. With Docker configured, execute:
docker run -d --name piladb -p $PILADB_PORT:1205 fern4lvarez/piladb # -d: start container in the background as a daemon # --name: give a name to the container # -p: `pilad` will listen on `$PILADB_PORT` from outside of the container # fern4lvarez/piladb is the official name of the image
This will bootstrap a
pilad instance, listening on a the Port number set with
For Developers 🔧
gitand Go +1.6 installed, and
If you want to develop or play with piladb you need to download the source code using Go:
go get -u github.com/fern4lvarez/piladb/... cd $GOPATH/src/github.com/fern4lvarez/piladb
Then you can run
make all to check that everything is OK. Take a look at the
README.md file, as it contains useful and important information for developers.
The Docker way
gitand Docker installed.
If you don't have or want Go installed in your machine, take the Docker way. This is not only valid for running
pilad from a container as we've seen previously, but also to provide a development environment where you can work without modifying your host machine.
The container comes with
git preinstalled, which is what you might need for basic development. Run this steps to get a dev setup up and running:
git clone https://github.com/fern4lvarez/piladb.git cd piladb cd dev make run # will start piladb container make bash # connect into the container
You are in! Now run
make all to check that you have indeed all you need inside the container.