Update rippled-example.cfg

Builds/VisualStudio2012/RippleD.vcxproj

@@ -1599,6 +1599,7 @@
     <None Include="..\..\modules\ripple_json\json\json_internalarray.inl" />
     <None Include="..\..\modules\ripple_json\json\json_internalmap.inl" />
     <None Include="..\..\modules\ripple_json\json\json_valueiterator.inl" />
+    <None Include="..\..\rippled-example.cfg" />
     <None Include="..\..\SConstruct" />
     <None Include="..\QtCreator\rippled.pro" />
   </ItemGroup>

Builds/VisualStudio2012/RippleD.vcxproj.filters

@@ -1680,6 +1680,7 @@
     <None Include="..\..\Doxyfile" />
     <None Include="..\..\SConstruct" />
     <None Include="..\QtCreator\rippled.pro" />
+    <None Include="..\..\rippled-example.cfg" />
   </ItemGroup>
   <ItemGroup>
     <Text Include="..\..\TODO.txt" />

rippled-example.cfg

@@ -225,13 +225,30 @@
 #
 #-------------------------------------------------------------------------------
 #
-# [node_db]
-# [temp_db]
-# [import_db]
+#   Database Configuration Settings
 #
-#   Set database options for storing node objects in the primary database,
-#   caching node objects in the temporary database, or importing node objects
-#   from a previous database.
+#   rippled creates 4 SQLite database to hold bookkeeping information
+#   about transactions, local credentials, and various other things.
+#   It also creates the NodeDB, which holds all the objects that
+#   make up the current and historical ledgers. The size of the NodeDB
+#   grows in proportion to the amount of new data and the amount of
+#   historical data (a configurable setting).
+#
+#   The performance of the underlying storage media where the NodeDB
+#   is placed can affect the performance of the server. Some virtual
+#   hosting providers offer high speed secondary storage, with the
+#   caveat that the data is not persisted across launches. If rippled
+#   runs in such an environment, it can be beneficial to configure the
+#   temp_db setting, which activates a secondary "look-aside" cache
+#   that can speed up the server. Some testing is suggested to determine
+#   if the temp_db setting is an improvement for your environment
+#
+#   Partial pathnames will be considered relative to the location of
+#   the rippled.cfg file.
+#
+#   [node_db]       Settings for the NodeDB (required)
+#   [temp_db]       Settings for the look-aside temporary db (optional)
+#   [import_db]     Settings for performing a one-time import (optional)
 #
 #   Format (without spaces):
 #       One or more lines of key / value pairs:
@@ -240,7 +257,7 @@
 #
 #   Examples:
 #       type=HyperLevelDB
-#       path=db/hashnode
+#       path=db/hyperldb
 #
 #   Choices for 'type' (not case-sensitive)
 #       HyperLevelDB        Use an improved version of LevelDB (preferred)
@@ -257,16 +274,24 @@
 #       (none yet)
 #
 #   Notes:
-#
 #       The 'node_db' entry configures the primary, persistent storage.
 #
 #       The 'temp_db' configures a look-aside cache for high volume storage
-#           which doesn't necessarily persist between server launches.
+#           which doesn't necessarily persist between server launches. This
+#           is an optional configuration parameter. If it is left out then
+#           no look-aside database is created or used.
 #
 #       The 'import_db' is used with the '--import' command line option to
 #           migrate the specified database into the current database given
 #           in the [node_db] section.
 #
+#   [database_path]   Path to the book-keeping databases.
+#
+#   There are 4 book-keeping SQLite database that the server creates and
+#   maintains. If you omit this configuration setting, it will default to
+#   creating a directory called "db" located in the same place as your
+#   rippled.cfg file.
+#
 #-------------------------------------------------------------------------------
 #
 # [node_size]
@@ -291,9 +316,6 @@
 #
 #   The default is: 256
 #
-# [database_path]
-#   Full path of database directory.
-#
 # [path_search_size]
 #   When searching for paths, the maximum number of nodes allowed. This can take
 #   exponentially more resources as the size is increased.
@@ -344,7 +366,7 @@ medium
 
 #[node_db]
 #type=HyperLevelDB
-#path=hyperldb
+#path=db/hyperldb
 
 [debug_logfile]
 log/debug.log