Skip to content

Commit 354bb72

Browse files
[release/v25.0] [DB-1658] Document Windows Service Limitations (#5261)
* Document Windows Service Limitations more info #5255 --------- Co-authored-by: Timothy Coleman <[email protected]>
1 parent d3aa8a5 commit 354bb72

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/server/quick-start/installation.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,17 @@ sc.exe start "KurrentDB"
288288

289289
Logs will still be written to the usual log file location. By default on windows this is the `logs` directory within the directory that contains `KurrentDB.exe`.
290290

291+
::: warning
292+
In this version the the service restart policy does not guarantee that the service is running. If running as a Windows Service, we recommend configuring
293+
the Windows Task Scheduler to start the service regularly (say, every 10 seconds), which will do nothing if the service is already running.
294+
295+
This is for two reasons, both of which we intend to address in a future version:
296+
297+
1. If the service shuts down gracefully, such as when going offline for truncation, it will be not be restarted by the policy.
298+
2. If the service does not start within 30s (by default), it will not be restarted by the policy. The 'start' that the service manager is looking for
299+
usually only takes a second or two, and is not related to the size of the database, but none the less there is some risk of timeout.
300+
:::
301+
291302
## Docker
292303

293304
You can run KurrentDB in a Docker container as a single node, using insecure mode. It is useful in most

0 commit comments

Comments
 (0)