From 83c323fbe10249a54d6383189fd9279d82c7d010 Mon Sep 17 00:00:00 2001
From: Azul <azul@riseup.net>
Date: Mon, 16 Sep 2013 08:33:03 +0200
Subject: point to default config file for options

add some explainations
---
 Readme.md           | 15 +--------------
 config/default.yaml | 19 ++++++++++++++-----
 2 files changed, 15 insertions(+), 19 deletions(-)

diff --git a/Readme.md b/Readme.md
index a8af53c..788ad46 100644
--- a/Readme.md
+++ b/Readme.md
@@ -64,20 +64,7 @@ Configuration
 
 For development on a couch with admin party you can probably leave all other options at their default values. For production you will need to set the credentials to an admin user so tapicero can create databases.
 
-The default options are:
-
-    # Database
-    #
-    users_db_name: "users"
-    db_prefix: "user-"
-    couch_connection:
-      protocol: "http"
-      host: "localhost"
-      port: 5984
-      username: ~
-      password: ~
-      prefix: ""
-      suffix: ""
+The default options and some explaination can be found in config/defaults.yaml
 
 Rake Tasks
 ----------------------------
diff --git a/config/default.yaml b/config/default.yaml
index 0e58e6e..e1ba45b 100644
--- a/config/default.yaml
+++ b/config/default.yaml
@@ -2,17 +2,21 @@
 # Default configuration options for Tapicero
 #
 
-#
-# Database
-#
+# database to observe for changes:
 users_db_name: "users"
+
+# prefix for per user databases:
 db_prefix: "user-"
+
+# couch connection configuration
 couch_connection:
   protocol: "http"
   host: "localhost"
   port: 5984
   username: ~
   password: ~
+
+# security settings to be used for the per user databases
 security:
   admins:
     names: []
@@ -21,5 +25,10 @@ security:
     names: 
       - soledad
     roles: []
-seq_file: "/tmp/tapicero.seq"
-log_file: "/var/log/leap/tapicero.log"
+
+# file to store the last processed user record in so we can resume after
+# a restart:
+seq_file: "/var/log/leap/tapicero.seq"
+
+# log file - Once we use a logger rather than writing to stdout we'll use this:
+# log_file: "/var/log/leap/tapicero.log"
-- 
cgit v1.2.3