Tremor can be installed in a variety methods such as through a package or compiling it from source code. We recommend following this quickstart guide which will use a Docker Image to get your first instance of Tremor running.
A running version of Docker on a system with an internet connection is required.
The simplest way to get Tremor is by downloading the Docker Image. You can install the latest version of Tremor by running the following command in terminal:
docker pull tremorproject/tremor:latest
The Tremor Docker image is configured by mounting a configuration folder to
The structure is as follows:
logger.yamlA log4rs configuration file.
config/*.trickleOne or more trickle files loaded in lexigraphical order to provide pipelines.
config/*.yamlOne or more YAML files with configurations for Onramps, Offramps and Bindings and Mappings.
For details on the files please consult the documentation.
Once downloaded and configured, run the following command in terminal to start the Tremor Docker Image:
docker run -v host/path/to/etc/tremor:/etc/tremor tremor-runtime
The following use case examples come with a full set of configuration files and a
docker-compose.yaml. To get a use case set up with a single command, inspect the following cases: