diff options
| author | kaeff <hi@kaeff.net> | 2015-09-01 13:42:29 +0200 |
|---|---|---|
| committer | kaeff <hi@kaeff.net> | 2015-09-01 14:48:15 +0200 |
| commit | 47d8ea67148bb8ebab333c78e90cd0baf2b028d0 (patch) | |
| tree | e64fe66589ae89b0aaa01a895ff61d09d1412d84 /doc | |
| parent | 1493e0ca5e32bf25d9778e7326ea70d5ebfe74e6 (diff) | |
Update README with docs from website & instructions on local DB
- Copy intro chapter from homepage
- Advise new users to not test with admin party locally
- Ignore couchdb.admin.yml so it's consistent with the regular
couchdb.yml
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/DEVELOP.md | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/doc/DEVELOP.md b/doc/DEVELOP.md index 991218e..cdd0867 100644 --- a/doc/DEVELOP.md +++ b/doc/DEVELOP.md @@ -1,5 +1,29 @@ # Development # +## Setting up the local CouchDB + +CouchDB operates in Admin Party by default, meaning there are no access +control checks. This is handy for local development. However, there is +the risk that running tests with Couch in Admin Party yields false +results. + +You have two options: + +1) Use Admin Party and accept the risk +2) Stop Admin Party by creating user accounts & security docs by running the +following script: + + test/travis/setup_couch.sh + +### Database configuration + +Copy & adapt the default database configuration: + +``` +mv config/couchdb.example.yml config/couchdb.yml +mv config/couchdb.admin.example.yml config/couchdb.admin.yml +``` + ## Continuous Integration ## See https://travis-ci.org/leapcode/leap_web for CI reports. @@ -88,4 +112,4 @@ One solution is to temporarily modify the apache config to proxypass the TLS req ProxyPassReverse / http://127.0.0.1:3000/ ProxyPreserveHost on .... - </virtualhost>
\ No newline at end of file + </virtualhost> |