Skip to content
The stream database optimised for event sourcing
C# C++ Shell JavaScript PowerShell C
Branch: master
Clone or download
thefringeninja Merge pull request #2279 from EventStore/enable-external-tcp
Add flag to enable external TCP interface
Latest commit 6f2a479 Feb 21, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fetch all tags Feb 17, 2020
ci GRPC Client and Server (#2012) Dec 5, 2019
etc Use generated assembly infos (#1999) Sep 13, 2019
scripts/build-js1 Remove vendored protogen and scripts now Grpc.Tools is in use Dec 5, 2019
src fix failing tests i.e. tests which use external tcp need it to be ena… Feb 21, 2020
.dockerignore Dockerized Build (#2087) Dec 5, 2019
.gitattributes Changed AssemblyInformationalVersion to explicitly include namespace Jul 17, 2013
.gitignore Move to Serilog And Wire Client to it (#2260) Feb 20, 2020
.gitmodules Add EventStore.UI as submodule Aug 13, 2018
Directory.Build.props build: Pull dependencies from NuGet instead of MyGet for now Sep 18, 2018
Dockerfile Consolidate Protos (#2291) Feb 18, 2020
LICENSE.md
README.md Update README after moving to .NET Core 3.1 Dec 30, 2019
build.cmd Provide ability to specify runtime and framework (#2143) Dec 13, 2019
build.ps1 Force gulp install Dec 23, 2019
build.sh Provide ability to specify runtime and framework (#2143) Dec 13, 2019
ci.yml Update ci.yml for Azure Pipelines Jan 19, 2020

README.md

Event Store

The open-source, functional database with Complex Event Processing in JavaScript.

This is the repository for the open source version of Event Store, which includes the clustering implementation for high availability.

Support

Information on commercial support and options such as LDAP authentication can be found on the Event Store website at https://eventstore.org/support.

CI Status

Build Status

Documentation

Documentation for Event Store can be found here

Community

We have a fairly active google groups list. If you prefer slack, there is also an #eventstore channel here.

Release Packages

The latest release packages are hosted in the downloads section on the Event Store Website

We also host native packages for Linux on Package Cloud and Windows packages can be installed via Chocolatey (4.0.0 onwards only).

Building Event Store

Event Store is written in a mixture of C#, C++ and JavaScript. It can run on Windows, Linux and macOS using the .NET Core runtime. However, the projections library (which uses the V8 javascript engine) contains platform specific code and it must be built for the platform on which you intend to run it.

Windows / Linux / macOS

Prerequisites

Build EventStore

Once you've installed the prerequisites for your system, you can launch a Release build of EventStore as follows:

dotnet build -c Release src/EventStore.sln -f netcoreapp3.1 -r <runtime identifier>

where <runtime identifier> needs to be replaced by the RID of the platform you want to build for.

The build scripts: build.sh and build.ps1 are 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/<runtime identifier>/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.

Running the tests

You can launch the tests as follows:

dotnet test src/EventStore.sln

Building the EventStore Client / Grpc Client / Embedded Client

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.

Client

dotnet pack -c Release src/EventStore.ClientAPI/EventStore.ClientAPI.csproj /p:Version=6.0.0

Grpc Client

dotnet pack -c Release src/EventStore.Grpc/EventStore.Grpc.csproj /p:Version=6.0.0

Embedded Client

dotnet pack -c Release src/EventStore.ClientAPI.Embedded/EventStore.ClientAPI.Embedded.csproj /p:Version=6.0.0

Building the EventStore web UI

The web UI repository is a git submodule of the current repository located under src/EventStore.UI.

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 build.sh ([<build_ui=yes|no>]) and build.ps1 (-BuildUI) scripts to allow you to do so.

Building the Projections Library

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.

Contributing

Development is done on the master branch. 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

You can’t perform that action at this time.