making examples consistent with dev and updating readme for static files

closes #441

diff --git a/.env.example b/.env.example
index f6199fb586e002437bdec769a1da6925b0ce8d1a..2156d8cba59a03e54b20a20e54873ba492395010 100644 (file)
--- a/.env.example
+++ b/.env.example
@@ -1,13 +1,13 @@
 DATABASE_URL='postgres://<user>:<password>@<host>:<port>/<database>'
 
-DEFAULT_FILE_STORAGE='storages.backends.s3boto.S3BotoStorage'
-AWS_ACCESS_KEY_ID='ASCIINONSENSE'
-AWS_SECRET_ACCESS_KEY='AlphaNumerics+OtherCharacters'
-AWS_STORAGE_BUCKET_NAME='bucket_name'
-CLOUDFRONT_DOMAIN='foo.cloudfront.net'
+#DEFAULT_FILE_STORAGE='storages.backends.s3boto.S3BotoStorage'
+#AWS_ACCESS_KEY_ID='ASCIINONSENSE'
+#AWS_SECRET_ACCESS_KEY='AlphaNumerics+OtherCharacters'
+#AWS_STORAGE_BUCKET_NAME='bucket_name'
+#CLOUDFRONT_DOMAIN='foo.cloudfront.net'
 #MTURK_HOST='mechanicalturk.amazonaws.com'
 
-SSL_REDIRECT=true
+#SSL_REDIRECT=true
 
 GOOGLE_SERVICE_EMAIL='numbers-alphanumerics@developer.gserviceaccount.com'
 GOOGLE_USER='Google@Email.Address'
@@ -16,8 +16,8 @@ GOOGLE_SERVICE_KEY_BASE64='Base64EncodedP12FileContentsGoHere'
 FILEPICKER_API_KEY='NonSeNsEAscIi'
 FILEPICKER_SECRET='MORENONSENSEASCII'
 
-INDEXDEN_PRIVATE_URL='http://:<password>@<something>.api.indexden.com'
-INDEXDEN_INDEX='index_name'
+#INDEXDEN_PRIVATE_URL='http://:<password>@<something>.api.indexden.com'
+#INDEXDEN_INDEX='index_name'
 
 CELERY_QUEUE_NAME='karmanotes_celery'
 
@@ -29,12 +29,12 @@ CELERY_QUEUE_NAME='karmanotes_celery'
 DJANGO_SETTINGS_MODULE='karmaworld.settings.dev'
 #DJANGO_SETTINGS_MODULE='karmaworld.settings.prod'
 
-BUILDPACK_URL='https://github.com/FinalsClub/heroku-buildpack-karmanotes'
+#BUILDPACK_URL='https://github.com/FinalsClub/heroku-buildpack-karmanotes'
 
 #NEW_RELIC_APP_NAME='name'
 #NEW_RELIC_LICENSE_KEY='hexademicalstring'
 #NEW_RELIC_LOG='stdout'
 
-SMTP_HOST='smtp.example.com'
-SMTP_USERNAME='username'
-SMTP_PASWORD='password'
+#SMTP_HOST='smtp.example.com'
+#SMTP_USERNAME='username'
+#SMTP_PASWORD='password'

diff --git a/README.md b/README.md
index dade1599b53bd412def55fa1109e961cae2d2846..73fbefa41eb95c190916d3c533ed657dfd91efbc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -438,6 +438,13 @@ desired.
 * `fetching_usde_csv` requires `7zip` to be installed for processing compressed
      archives. On Debian-based systems, this entails `apt-get install p7zip-full`
 
+If using `DJANGO_SETTINGS_MODULE='karmaworld.settings.dev'` in `.env`, static
+file hosting is done by local files and completely ignores the
+`DEFAULT_FILE_STORAGE` setting in `.env`.
+
+If using `DJANGO_SETTINGS_MODULE='karmaworld.settings.prod'` in `.env`, static
+file hosting is done by `DEFAULT_FILE_STORAGE` defined in `.env`.
+
 ## Run
 
 Make sure you are inside your virtual environment (`source venv/bin/activate`).