We highly recommend updating your Linux OS prior to launching the RavenDB server. Also, check if .NET Core requires any other prerequisites in the Prerequisites for .NET Core on Linux article written by Microsoft.
We recommend setting up your cluster nodes on separate machines so that if one goes down, the others can keep the cluster active.
Set up a server folder on each machine that will host the nodes in your cluster.
You may want to include the node designation (nodes A, B, C...) in the name of each server folder, to prevent future confusion.
Extract the server package into permanent server folders on each machine.
Each folder that contains an extracted server package will become a functional node in your cluster.
If you've set up on separate machines, go to step 3 below.
If you move this folder after installation, the server will not run.
You'll receive a 'System.InvalidOperationException: Unable to start the server.' error because it will look for the file path that is set
when you install. If you must move your folder at a later time, you can reconfigure the certificate file path
in the settings.json file.
If you choose to use only one machine (although this will increase the chances of your cluster going down) you'll need to:
Set up a parent folder in a permanent location for your installation package and server settings for the next steps.
Set up separate folders in the parent folder for each node and keep it in a safe place for future use.
Extract the downloadedRavenDB...zip server package into each node folder.
If you want to install the cluster as a service (it will improve availability because it will automatically run in the background every time your
machine restarts), this simple step will be done after initial secure installation via the Setup Wizard or manually. Read Running as a Service.
If you want to test RavenDB without manual setup try RavenDB Cloud.
We offer one free instance per customer. For more information, please read our dedicated article.
Help Us Improve Prompt
When you first launch RavenDB, you will see this prompt asking if you'd be willing to
anonymously share some Studio usage data with us in order to help us improve RavenDB:
Help Us Improve
Once you respond to this prompt, it should not appear again. However, in some scenarios,
such as running RavenDB embedded, or working without browser cookies, the prompt may
If necessary, you can add this flag to the Studio URL to prevent the prompt from
The RavenDB server uses a settings.json file in each node Server folder to store the server-wide configuration options.
When starting a server, RavenDB will look for the settings.json file in the node Server folder, so it must be located there.
The Setup Wizard places it correctly automatically.
After making changes to this file, a server restart is required for them to be applied.
You can read more about the available configuration options in our dedicated article.
The configuration file included in each RavenDB server distribution package is as follows:
If you intend to run as a service, the write permissions should be granted to the user running the service (e.g. "Local Service").
Our GUI, the RavenDB Management Studio, comes free with every license type:
After installation and setup, the Studio can be accessed via the browser using the ServerUrl or the ServerPublicUrl value e.g. http://localhost:8080.
Whenever you run the server folder script run.ps1 the Studio opens automatically in your browser.
We recommend using the 'Setup Wizard' to easily install RavenDB securely from the very start to prevent potential future vulnerability. The process in RavenDB only takes a few minutes and is free.
To let a developer start coding an application quickly, RavenDB will run with the following default security mode:
Default Security Mode
As long as the database is used inside the local machine and no outside connections are allowed, you can ignore security concerns
and you require no authentication. Once you set RavenDB to listen to connections outside your local machine,
your database will immediately block this now vulnerable configuration and require the administrator to properly set up the security and
access control to prevent unauthorized access to your data or to explicitly allow the unsecured configuration.
We recommend using the 'Setup Wizard' to easily install RavenDB securely from the very start to prevent potential future vulnerability. The process takes a few minutes and is free.
In order to start, you need to create an instance of the DocumentStore - the main entry point for your application which is responsible for establishing and managing connections between a RavenDB server (or cluster) and your application.
Before proceeding to the examples, we would like to point out that most of the articles are using the Northwind database. You can read more about it and how to deploy it here.
The DocumentStore is capable of working with multiple databases and for proper operation we recommend having only one instance of it per application.
The following articles can extend your knowledge about the DocumentStore and its configuration:
The Session is used to manipulate the data. It implements the Unit of Work pattern and is capable of batching the requests to save expensive remote calls. In contrast to a DocumentStore it is a lightweight object and can be created more frequently. For example, in web applications, a common (and recommended) pattern is to create a session per request.
Example I - Storing
RavenDB is a Document Database. All stored objects are called documents. Each document contains a unique ID that identifies it, data and adjacent metadata, both stored in JSON format. The metadata contains information describing the document, e.g. the last modification date (@last-modified property) or the collection (@collection property) assignment.
Example II - Loading
The Session was designed to help the user write efficient code easily. For example, when a document is being loaded (.Load) from the server, there is an option to retrieve additional documents in the same request (using .Include), minimizing the number of expensive calls.
Besides that, the session implements the Unit of Work pattern, meaning that all changes to loaded entities are automatically tracked. The SaveChanges call will synchronize (with the server) only the documents that have changed within the session. All of those changes are sent in one request (saving network calls) and processed in one transaction (you can read why RavenDB is an ACID database here).
Example III - Querying
To satisfy queries, indexes are used. From the querying perspective, an index defines which document fields can be used to find a document. The whole indexing process is done asynchronously, which gives very quick querying response times, even when large amounts of data have been changed. However, an implication of this approach is that the index might be stale.
When no index is specified in the query (like in the query below), RavenDB will use its intelligent auto-indexes feature that will either use an already existing index or create a new one if no match is found.
The other option is to write the index yourself and deploy it to the server. Those indexes are called Static Indexes.
Behind the scenes, queries are translated to the Raven Query Language (RQL) syntax. Read more about RQL here.
Session - The following articles can extend your knowledge about the Session: