[whimsy] branch master updated: Overview of configuration details, mostly pointing to other information

[cu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

curcuru pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git

The following commit(s) were added to refs/heads/master by this push:
       new  62a1635   Overview of configuration details, mostly pointing to other information
62a1635 is described below

commit 62a1635a30672afe1d94bca7eb420c8490479d8c
Author: Shane Curcuru <as...@shanecurcuru.org>
AuthorDate: Mon Apr 3 19:43:42 2017 -0400

    Overview of configuration details, mostly pointing to other information
---
 CONFIGURE.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/CONFIGURE.md b/CONFIGURE.md
new file mode 100644
index 0000000..22aa61e
--- /dev/null
+++ b/CONFIGURE.md
@@ -0,0 +1,39 @@
+# Configuring Whimsy
+
+As a collection of tools that directly access organizational data, 
+there are a number of places that you will need to configure to 
+have most of the code work as expected.
+
+## Local Clients / Development
+
+Whimsy can be run on a client or in a local container for development use.
+
+* **App-wide default settings** are stored in a YAML formatted 
+  `~/.whimsy` file, notably including an `svn` pointer to where various 
+  local repo checkouts live as well as `sendmail` config (if used).  
+  See also `lib/whimsy/asf/config.rb`
+  
+* **LDAP configuration** will be stored in `/etc/(ldap|openldap)/ldap.conf`
+  and will point to the production ASF LDAP servers along with associated 
+  certificate.  See also `lib/whimsy/asf/ldap.rb` and `ASF::LDAP.configure`. 
+
+* **Web server configuration** - much of Whimsy runs within an Apache 
+  httpd instance, so see the usual `/etc/apache2/httpd.conf` along 
+  with associated Rack and/or Phusion configurations.
+  
+* **Log files and debugging** are typically found in `/var/log/apache2/whimsy_error.log` 
+  and `/var/log/apache2/error_log`
+  
+* **Development setup instructions** are in [DEVELOPMENT.md](DEVELOPMENT.md) and [MACOSX.md](DEVELOPMENT.md).
+
+* **whimsy-asf Gem** is a set of the core whimsy model as a normal Gem: [asf.gemspec](asf.gemspec)
+  
+* **Tool-specific configurations** can be found in config/ directory  
+
+## Production whimsy
+
+See [DEPLOYMENT.md](DEPLOYMENT.md) for full details.  We use Puppet to 
+provision the production VM with the basic dependencies as well as the 
+Whimsy code.  A number of configuration steps ensure the production instance
+has access to LDAP, SVN repositories (some read/write), local mail
+sending and receiving/subscriptions.

-- 
To stop receiving notification emails like this one, please contact
['"commits@whimsical.apache.org" <co...@whimsical.apache.org>'].