From 4a27f22fae2640e050e7f90b1dfa6fe570204b44 Mon Sep 17 00:00:00 2001
From: Simon Rettberg
Date: Mon, 13 Jan 2014 12:16:06 +0100
Subject: [SERVER] Add example config

---
 server.config.example/README | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 server.config.example/README

(limited to 'server.config.example/README')

diff --git a/server.config.example/README b/server.config.example/README
new file mode 100644
index 0000000..285758b
--- /dev/null
+++ b/server.config.example/README
@@ -0,0 +1,30 @@
+Configuration for dnbd3-server
+
+The server requires a config directory.
+Start it like so: ./dnbd3-server -c ./my-config/
+
+There are two files in that dir
+
+== alt-servers ==
+List of known alt-servers for this server.
+Format:
+[PREFIX]<IP:PORT> [Comment]
+
+Prefix can be:
++ - Only report server to clients as alt-server, but don't use for replication
+- - Only use server for replication, but don't advertise to clients
+No prefix means server will be advertised to clients and is used for replication
+
+If you're not running in proxy mode, this file won't do much for you
+
+== server.conf ==
+
+Main configuration file. Ini format.
+
+[dnbd3]
+basePath=/srv/openslx/dnbd3 # virtual root of image files
+serverPenalty=1234 # artificial acceptance delay for incoming server connections (µs)
+clientPenalty=2345 # artificial acceptance delay for incoming client connection (µs)
+isProxy=true # enable proxy mode - will try to replicate from alt-servers if a client requests unknown image
+uplinkTimeout=1250 # r/w timeout for connections to uplink servers
+
-- 
cgit v1.2.3-55-g7522