Skip to content
On this page

Install from Source

This guide will show you how to install Bondy from its source.

TIP

If this is your first time trying Bondy, you might prefer to start with one of our tutorial examples. Some of them use Docker Compose so you can start reviewing Bondy without installing it locally.

Prerequisites

  • Operating Systems: macOS (Intel|Apple Silicon) or Linux (AMD64|ARM64)
  • Erlang 24 or later
  • Rebar3 3.17.0 or later
  • openssl
  • libssl
  • Libsodium
  • libsnappy
  • liblz4

Steps

1. Building

Clone the repository and cd to the location where you cloned it.

To generate a Bondy release to be used in production execute the following command which will generate a tarball containing the release at $(PWD)/_build/prod/rel/.

bash
rebar3 as prod tar
1

Untar and copy the resulting tarball to the location where you want to install Bondy e.g. ~/tmp/bondy.

bash
tar -zxvf _build/prod/rel/bondy-1.0.0-beta.28.tar.qz -C ~/tmp/bondy
1

2. Running

To run Bondy, cd to the location where you installed it e.g. ~/tmp/bondy and run the following command which will print all the options.

bash
bin/bondy
1

For example, to run Bondy with output to stdout do

bash
bin/bondy foreground
1

And to run Bondy with an interactive Erlang shell do

bash
bin/bondy console
1

Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-ShareAlike (CC-BY-SA) 4.0 International license.
Bondy and Leapsight are registered trademarks.