Skip to content

Installing EventSourcingDB

This guide shows how to install EventSourcingDB and verify that it's working correctly. It covers Docker as well as macOS, Linux and Windows. At the end, you will have a running EventSourcingDB instance, ready for use.

Using Docker

Docker is the recommended way to run EventSourcingDB, as it simplifies the setup process by providing a pre-configured environment.

Downloading the Latest Version

To get the latest version of EventSourcingDB, run:

docker pull thenativeweb/eventsourcingdb

Downloading a Specific Version

To fetch a specific version, add the desired version number as a tag. For example, to download version 1.2.0:

docker pull thenativeweb/eventsourcingdb:1.2.0

A complete list of available versions is available on Docker Hub.

Verifying the Installation

After downloading, verify the installation by checking the version:

docker run thenativeweb/eventsourcingdb version

This command will display the installed version of EventSourcingDB. If the version number matches your expectation, the installation was successful.

For additional details, refer to Deploying with Docker, Deploying on Kubernetes, Managing Configuration and Secrets, and Running EventSourcingDB.

Using Pre-Built Binaries

If you prefer not to use Docker, you can download pre-built binaries for your operating system and CPU architecture using the links below:

Looking for a Specific Version?

Pre-built binaries are only available for the latest version of EventSourcingDB. If you need a specific version, consider using the Docker image.

Post-Download Steps

Renaming the Binary

Rename the binary for simpler usage:

mv eventsourcingdb-darwin-arm64 eventsourcingdb

mv eventsourcingdb-linux-arm64 eventsourcingdb

ren eventsourcingdb-windows-arm64.exe eventsourcingdb.exe

Note for x86 Users

Replace arm64 with amd64 in the file name if you are using an x86 architecture.

Making the Binary Executable

Files downloaded from the internet are marked with a quarantine attribute by macOS, which prevents them from being run. Remove the quarantine attribute:

xattr -d com.apple.quarantine eventsourcingdb

Make the binary executable:

chmod a+x eventsourcingdb

Make the binary executable:

chmod a+x eventsourcingdb

On Windows, no additional steps are required.

Verifying the Installation

After renaming and adjusting permissions, verify the installation by checking the version:

./eventsourcingdb version

./eventsourcingdb version

eventsourcingdb version

This command will display the installed version of EventSourcingDB. If the version number matches your expectation, the installation was successful.

For additional details, refer to Deploying the Pre-Built Binary, Managing Configuration and Secrets, and Running EventSourcingDB.