feat(docker-compose): Add docker-compose.yml #100 (#130)

* feat(docker-compose): Add `docker-compose.yml` #100

Signed-off-by: Ryan Russell <git@ryanrussell.org>

* docs(build-from-source): Include build from source

Signed-off-by: Ryan Russell <git@ryanrussell.org>
This commit is contained in:
Ryan Russell 2022-06-10 08:30:05 -05:00 committed by GitHub
parent e82a378354
commit ff632b1c4b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 223 additions and 9 deletions

66
docs/build-from-source.md Normal file
View file

@ -0,0 +1,66 @@
# Build DragonflyDB From Source
## Running the server
Dragonfly runs on linux. It uses relatively new linux specific [io-uring API](https://github.com/axboe/liburing)
for I/O, hence it requires `Linux verion 5.10` or later.
Debian/Bullseye, `Ubuntu 20.04.4` or later fit these requirements.
### WARNING: Building from source on older kernels WILL NOT WORK.
If your host machine does not have at least `Linux verion 5.10` or later, we suggest you choose a [Dockerized Quick Start](/docs/quick-start/).
## Step 1
```bash
git clone --recursive https://github.com/dragonflydb/dragonfly && cd dragonfly
```
## Step 2
```bash
# Install dependencies
sudo apt install ninja-build libunwind-dev libboost-fiber-dev libssl-dev \
autoconf-archive libtool cmake g++
```
## Step 3
```bash
# Configure the build
./helio/blaze.sh -release
# Build
cd build-opt && ninja dragonfly
```
## Step 4
```bash
# Run
./dragonfly --alsologtostderr
```
Dragonfly DB will answer to both `http` and `redis` requests out of the box!
You can use `redis-cli` to connect to `localhost:6379` or open a browser and visit `http://localhost:6379`
## Step 5
Connect with a redis client
```bash
redis-cli
127.0.0.1:6379> set hello world
OK
127.0.0.1:6379> keys *
1) "hello"
127.0.0.1:6379> get hello
"world"
127.0.0.1:6379>
```
## Step 6
Continue being great and build your app with the power of DragonflyDB!