All the configuration options detailed below are defined in the section of your config file as separate values. When running RavenDB as a website (through IIS, or in Embedded mode), the config file is web.config; otherwise it is the Raven.Server.exe.config file.
Changes to the config file or additions / removal from the Plugins directory will not be picked up automatically by the RavenDB service. For your changes to be recognized you will need to restart the service. You can do so calling: Raven.Server.exe /restart.
If you are running in Embedded mode, or RavenDB is running as an IIS application, touching the web.config file will cause IIS to automatically restart RavenDB.
Sample configurations file
This is the standard app.config XML file. The appSettings section is where the global configuration options go, also for web applications which have a web.config file instead.
The maximum page size that can be specified on this server. Default: 1024 Minimum: 10
The expiration value for documents in the internal document cache. Value is in seconds. Default: 5 minutes
The max size in MB for the internal document cache inside RavenDB server. Default: 50% of the total system memory minus the size of the Esent cache.
The percentage of memory that the internal document cache inside RavenDB server will use. Default: 0 (auto)
The internal for checking that the internal document cache inside RavenDB server will be cleaned. Format: HH:MM:SS Default: depends on system polling interval
If the database is being loaded for the first time, this value indicates how many seconds will task wait for load completion before throwing exception. Default: 5
Indicates minimum worker threads amount value for the .net thread pool. Might be usefull when one wants to help the system to deal with violent bursts of work.
Default: ThreadPool current value
Indicates minimum completion threads amount value for the .net thread pool. Might be usefull when one wants to help the system to deal with violent bursts of work.
Default: ThreadPool current value Minimum: 2
The path for the indexes on disk. Useful if you want to store the indexes on another HDD for performance reasons. Default: ~/Data/Indexes
The number of writes before index writer will be recreated (to save memory). Default: 256 * 1024
The number of indexing tasks that can be run in parallel. There is usually one or two indexing tasks for each index. Default: the number of processors in the current machine
The max number of items that will be indexed in a single batch. Larger batch size result in faster indexing, but higher memory usage. Default: 128 * 1024 for 64-bit and 16 * 1024 for 32-bit Minimum: 128
The max number of items that will be indexed in a single batch. Larger batch size result in faster indexing, but higher memory usage. Default: 1/2 * Raven/MaxNumberOfItemsToIndexInSingleBatchMinimum: 128
The max number of items that will be prefetched for indexing. Larger batch size result in faster indexing, but higher memory usage. Default: 128 * 1024 for 64-bit and 16 * 1024 for 32-bit Minimum: 128
The number of items that will be indexed in a single batch. Larger batch size result in faster indexing, but higher memory usage. Default: 512 for 64-bit and 256 for 32-bit
The minimum amount of memory available for us to double the size of InitialNumberOfItemsToIndexInSingleBatch if we need to. Default: 50% of total system memory Minimum: 768
When the database is shut down rudely, determine whatever to reset the index or to check it. Note that checking the index may take some time on large databases. Default: false
What is the suggested max latency for a single indexing run that allows the database to increase the indexing batch size. Default: 5 minutes
Time that server is waiting before running idle indices. Default: 10 minutes
Time that server will wait before marking auto index as idle. Default: 1 hour
Time that server will wait before running abandoned indices. Default: 3 hours
Time that server will wait before marking idle indices as abandoned. Default: 72 hours
The TaskScheduler type to use for executing indexing.
The max size in MB of a new index held in memory. When the index exceeds that value, it will be using a disk rather than memory for indexing. Default: 64 MB Minimum: 1 MB
Whatever we allow creation of auto indexes on dynamic queries. Default: true
Control whatever the Studio default indexes will be created or not. These default indexes are only used by the UI, and are not required for RavenDB to operate. Default: false
Control whatever RavenDB limits what the indexes can do (to avoid potentially destabilizing operations). Default: false
Path to a directory used by index compilator. Default: ~\Raven\CompiledIndexCache
The number that controls if single step reduce optimization is performed. If the count of mapped results is less than this value then the reduce is executed in a single step. Default: 1024
Disables the document prefetcher.
Maximum time interval for storing commit points for map indexes when new items were added. The commit points are used to restore index if unclean shutdown was detected. Default: 5 minutes
Maximum number of kept commit points to restore map index after unclean shutdown. Default: 5
Minimum interval between between successive indexing that will allow to store a commit point. Default: 1 minute
Prevent all new created indexes from being kept in memory. In order to set this option per index you need to specify it in its IdexDefinition. Default: false
Maximum number of megabytes that can be used by database to control the maximum size of the processing batches. Default: 1024 or 75% percent of available memory. Default: 1024 or 75% percent of available memory if 1GB is not available
Whatever the database should run purely in memory. When running in memory, nothing is written to disk and if the server is restarted all data will be lost. This is mostly useful for testing. Default: false
The path for the database directory. Can use ~\ as the root, in which case the path will start from the server base directory. Default: ~\Data
What storage type to use (see: RavenDB Storage engines) Allowed values: esent, munin Default: esent
What transaction mode to use. Safe transaction mode ensures data consistency, but is slower. Lazy is faster, but may result in a data loss if the server crashes. Allowed values: Lazy, Safe Default: Safe
The hostname to bind the embedded http server to, if we want to bind to a specific hostname, rather than all. Default: none, binds to all host names
The port to use when creating the http listener.
Allowed: 1 - 65,536 or * (find first available port from 8080 and upward) Default: 8080
The virtual directory for the RavenDB server. Default: /
Whatever http compression is enabled. Default: true
Enable/disable SSL. Note: this only applies when RavenDB is run as a windows service.Default: false
Configures the server to send Access-Control-Allow-Origin header with the specified value. If this value isn't specified, all the access control settings are ignored. Allowed values: null (don't send the header), *, http://example.org, Default: none
Configures the server to send Access-Control-Max-Age header with the specified value. Default: 1728000 (20 days)
Configures the server to send Access-Control-Allow-Methods header with the specified value. Default: PUT, PATCH, GET, DELETE, POST.
Configures the server to send Access-Control-Request-Headers header with the specified value. Default: none
Maximum number of allowed request to databases that are being loaded before warning messages will be returned.
The full license string for RavenDB. If Raven/License is specified, it overrides the Raven/LicensePath configuration.
The path to the license file for RavenDB. Default: ~\license.xml
Name of the server that will show up on /admin/stats endpoint.
Name of the cluster that will show up on /admin/stats endpoint.
Semicolon separated list of bundles names, such as: 'Replication;Versioning'. If the value is not specified, none of the bundles are installed. Default: none
Allow to limit the loaded plugins by specifying a search pattern, such as Raven.*.dll. Multiple values can be specified, separated by a semicolon (;).
The location of the plugins directory for this database. Default: ~\Plugins
The location of the web directory for known files that makes up the RavenDB internal website. Default: ~/Raven/WebUI
The url to redirect the user to when then try to access the local studio.
The size in MB of the Esent page cache, which is the default storage engine. Default: 256 for 32-bit and 25% of total system memory for 64-bit Minimum: 256 for 32-bit and 1024 for 64-bit
The maximum size of version store (in memory modified data) available. The value is in megabytes. Default: 512
The size that the database file will be enlarged with when the file is full. The value is in megabytes. Lower values will result in smaller file size, but slower performance. Default: 8
The size of the database log file. The value is in megabytes. Default: 64
The size of the in memory buffer for transaction log. Default: 16
The maximum number of cursors allowed concurrently. Default: 2048
The path for the esent logs. Useful if you want to store the indexes on another HDD for performance reasons. Default: ~/Data/Logs
Whatever circular logs will be used, defaults to true. If you want to use incremental backups, you need to turn this off, but logs will only be truncated on backup. Default: true
The time in seconds to allow a tenant database to be idle. Value is in seconds. Default: 900
The time in seconds to check for an idle tenant database. Value is in seconds. Default: 60
The hard limit after which we refuse any additional writes. Default: none
The soft limit before which we will warn about the quota. Default: 1024
The hard limit after which we refuse any additional documents. Default: Int64.MaxValue
The soft limit before which we will warn about the document limit quota. Default: Int64.MaxValue
Number that will expand Raven/MaxStepsForScript based on a document size. Formula is as follows: MaxStepsForScript = Raven/MaxStepsForScript + (documentSize * Raven/AdditionalStepsForScriptBasedOnDocumentSize)
Determines what actions an anonymous user can do. Get - read only, All - read & write, None - allows access to only authenticated users, Admin - all (including administrative actions). Default: Get
If your database instance does not have a valid license then Admin is the only available option to set. In a commercial system it should not be used. It is only for testing and development purposes, since it grants to ANY user administrative rights.
If set local request don't require authentication. Default: Get
The url clients should use for authenticating when using OAuth mode. Default: http://RavenDB-Server-Url/OAuth/AccessToken - the internal OAuth server.
The path to the OAuth certificate. Default: none. If no certificate is specified, one will be automatically created.
The password for the OAuth certificate. Default: none
Raven/Encryption/Algorithm AssemblyQualifiedName value. Additionaly provided type must be a subclass of SymmetricAlgorithm from System.Security.Cryptography namespace and must not be an abstract class. Default: "System.Security.Cryptography.AesManaged, System.Core, Version=18.104.22.168, Culture=neutral, PublicKeyToken=b77a5c561934e089"
Key used for encryption purposes with minimum length of 8 characters, base64 encoded.
Boolean value indicating if the indexes should be encrypted. Default: True
Availability of configuration options
Many of the configuration options described in section above can be used both in global and per database context. If you want to set configuration per database, please refer to this page.
Raven/ActiveBundles can be changed after database has been created, but any changes may cause unexpected stability issues and are HIGHLY unrecommended. Please activate bundles only when creating new database.
Raven/Encryption settings can only be provided when database is being created. Changing them later will cause DB malfunction. More about Encryption bundle can be found here.