Installation

Reveald is distributed as a single static binary. Download the latest release for your platform from GitHub Releases.

Binary install

curl -L https://github.com/runreveal/reveald/releases/latest/download/reveald-linux-amd64.tar.gz | sudo tar --directory /usr/local/bin -xz
sudo chmod +x /usr/local/bin/reveald
reveald --help

Docker

docker pull runreveal/reveald:latest
 
docker run --rm \
  -v $(pwd)/config.json:/config.json:ro \
  runreveal/reveald:latest \
  run --config /config.json

For production Docker deployments, see Docker deployment.

Verify installation

reveald --help

You should see the available commands and flags. The primary command is run:

reveald run --config /path/to/config.json

Next steps

• Quickstart --- Send your first logs to RunReveal
• Configuration --- Learn the config file format