Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 1.85 KB

installation.md

File metadata and controls

68 lines (46 loc) · 1.85 KB
Raw

Installation

Entropy installation is simple. You can install Entropy on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. There are several approaches to installing Entropy.

  1. Using a pre-compiled binary
  2. Installing with package manager
  3. Installing from source
  4. Installing with Docker

Binary (Cross-platform)

Download the appropriate version for your platform from releases page. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account. Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

Homebrew

# Install entropy (requires homebrew installed)
$ brew install odpf/taps/entropy

# Upgrade entropy (requires homebrew installed)
$ brew upgrade entropy

# Check for installed entropy version
$ entropy version

Building from source

To compile from source, you will need Go installed in your PATH.

# Clone the repo
$ https://github.com/odpf/entropy.git

# Build entropy binary file
$ make build

# Check for installed entropy version
$ ./entropy version

Using Docker image

Entropy ships a Docker image odpf/entropy that enables you to use entropy as part of your Docker workflow.

For example, you can run entropy version with this command:

$ docker run odpf/entropy version

Verifying the installation

To verify Entropy is properly installed, run entropy version on your system.

$ entropy version

Running tests

# Running all unit tests, excluding extractors
$ make test