The stream database optimised for event sourcing
This is the repository for the open source version of EventStoreDB, which includes the clustering implementation for high availability.
Information on support and commercial tools such as LDAP authentication can be found here: Event Store Support.
Read more in the documentation contribution guidelines.
The latest release packages are hosted in the downloads section on the Event Store website: Event Store Downloads
Prerequisites - .NET Core SDK 5.0
Once you've installed the prerequisites for your system, you can launch a
Releasebuild of EventStore as follows:
dotnet build -c Release src/EventStore.sln -f netcoreapp5.0 -r
whereneeds to be replaced by the RID of the platform you want to build for.
The build scripts:
build.ps1are also available for Linux/macOS and Windows respectively to simplify the build process.
To start a single node, you can then run:
dotnet bin/Release/EventStore.ClusterNode/netcoreapp3.1//EventStore.ClusterNode.dll --db /path/to/db --log /path/to/logs
Note: The build system has changed after version
5.0.5, therefore the above instructions will not work for older releases.
You can launch the tests as follows:
dotnet test src/EventStore.sln
You can build the different clients by following the steps below. This will generate a nuget package file (.nupkg) that you can include in your project.
dotnet pack -c Release src/EventStore.ClientAPI/EventStore.ClientAPI.csproj /p:Version=6.0.0
dotnet pack -c Release src/EventStore.Grpc/EventStore.Grpc.csproj /p:Version=6.0.0
dotnet pack -c Release src/EventStore.ClientAPI.Embedded/EventStore.ClientAPI.Embedded.csproj /p:Version=6.0.0
The web UI repository is a git submodule of the current repository located under
The web UI is prebuilt and the files are located in src/EventStore.ClusterNode.Web/clusternode-web. However, if you still want to build the latest web UI, there is a parameter in the
-BuildUI) scripts to allow you to do so.
The list of precompiled projections libraries can be found in
src/libs/x64. If you still want to build the projections library please follow the links below. - Windows - Linux - macOS
Development is done on the
masterbranch. We attempt to do our best to ensure that the history remains clean and to do so, we generally ask contributors to squash their commits into a set or single logical commit.
If you want to switch to a particular release, you can check out the tag for this particular version. For example:
git checkout oss-v6.0.0-preview1
Read more in the contribution guidelines.
If you update the protos, continuous integration will fail. After ensuring the proto change is backwards compatible, please run
./protolock.sh commitat the root of this repository.