Merge lp:~zyga/lava-dashboard/0.1.CONFIGURED-fix into lp:lava-dashboard/0.1

[Zygmunt Krynicki]

This branch adds an important bug fix to dashboard_server configuration.

Without this fix a set of development settings in settings.py will _always_ override customized local settings in local_settings.py

This branch fixes this by importing the variable CONFIGURED from local_settings.py (if it exists).

[Paul Larson (pwlars)]

I'm not sure I like this approach. It depends on the administrator to know that they need to have CONFIGURED set to something in the local_settings. I realize the example has this, but why not just do something like:
try:
    from local_settings import *
except ImportError:
    ...do default config here

review: Needs Information

[Zygmunt Krynicki (zyga)]

> I'm not sure I like this approach. It depends on the administrator to know
> that they need to have CONFIGURED set to something in the local_settings. I
> realize the example has this, but why not just do something like:
> try:
> from local_settings import *
> except ImportError:
> ...do default config here

I agree with the downside. I wanted to have an option of always using local_settings.py (I use it for development to add some extra installed apps and middleware for development). How about we use this approach:

from default_settings import *
try:
    from local_settings import *
except ImportError:
    from development_settings import *

So there would be no CONFIGURED anymore and you could still use local_settings like I do (although you'd need to import development_settings inside your local settings for that).

[lp:~zyga/lava-dashboard/0.1.CONFIGURED-fix]

56. By Zygmunt Krynicki on 2010-09-29

Rework configuration so that it's easier to get started

[Zygmunt Krynicki (zyga)]

Reworked as described in the previous comment. Please review as this needs to get out

[Paul Larson (pwlars)]

75 +SCRET_KEY = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
Should be SECRET_KEY

I'm not sure I understand adding development_settings.py rather than just have this in the default_settings.py or settings.py. I understand wanting to split it up to allow for easier configuration and the advantage of not having a single, monolithic settings file. However, the end result is complicated and non-standard. I feel like I need a map of what goes where, and what supersedes what. I would seriously consider simplifying this back down a bit unless there is a really good reason not to.

[lp:~zyga/lava-dashboard/0.1.CONFIGURED-fix]

57. By Zygmunt Krynicki on 2010-09-29

Fix typo

58. By Zygmunt Krynicki on 2010-09-30

Improved installation instructions

[Zygmunt Krynicki (zyga)]

I need to get this out and release 0.1.1.
Merging despite lack of approve here

=== modified file 'INSTALL'
--- INSTALL	2010-09-23 02:18:48 +0000
+++ INSTALL	2010-09-30 08:47:43 +0000
@@ -1,25 +1,76 @@
-The following script is suitable for installation in /opt (code & settings) and /srv (data).
-(the script is meant to be read and executed manually, you need to interact with some steps)
-
-	mkdir -p /opt/dashboard/
-	mkdir -p /srv/dashboard/media
-	bzr get lp:launch-control/0.1 /opt/dashboard/stable
-	
-	# Things to do here:
-	# 1) specify system administrators
-	# 2) set SECRET_KEY
-	# 3) configure database settings
-	# 4) confirm installation and data paths
-	cp /opt/dashboard/stable/dashboard_server/local_settings.py.example /opt/dashboard/stable/dashboard_server/local_settings.py
-	/opt/dashboard/stable/dashboard_server/manage.py syncdb
-	chown -R www-data.www-data /srv/dashboard/
-	cp /opt/dashboard/stable/dashboard_server/apache.conf /etc/apache2/sites-available/dashboard
-	
-	# Tweak to your preference, default is to have a *:80/dashboard/ virtual host
-	$EDITOR /etc/apache2/sites-available/dashboard
-	a2ensite dashboard
-	service apache restart
-
-Now go to your-site/dashboard/admin and sign-in with the username and password you provided.
-Before the system can be used you must create an anonymous bundle stream. You can do this
-by selecting "Bundle Streams" "Add" and "Save" from the admin panel.
+Installation
+============
+
+There are two possible options for installation right now:
+
+1) Run directly from the checkout (development and evaluation)
+2) Install in /opt + /srv and configure to run via apache (production)
+
+The first option is attractive to anyone who just wants to try it out without
+any hassle. The second option should be used if you plan on having a
+continuous service.
+
+
+Running directly from a checkout
+================================
+
+There is very little you have to do, assuming you already have a checkout (if
+you are reading this online and have bazaar installed you can get the latest
+stable source directly from trunk with `bzr get lp:launch-control') you only
+need to make sure you have required dependencies (see README) 
+
+From within the source tree issue the following commands:
+1) ./dashboard_server/manage.py syncdb
+2) ./dashboard_server/manage.py runserver
+
+Then open your favourite browser and point it at http://localhost:8000/
+
+
+Installation in /opt + /srv
+===========================
+
+The following script is suitable for installation in /opt (code & settings)
+and /srv (data).  Tthe script is meant to be read and executed manually, you
+need to interact with some steps
+
+# Setup space for code and data and fetch latest tree
+sudo mkdir -p /opt/dashboard/
+sudo mkdir -p /srv/dashboard/media
+sudo chown www-data.www-data /srv/dashboard/
+sudo bzr get lp:launch-control/0.1 /opt/dashboard/stable
+
+# Configure web server and dashboard for production deployment
+sudo cp /opt/dashboard/stable/dashboard_server/local_settings.py.example /opt/dashboard/stable/dashboard_server/local_settings.py
+# Things to do here:
+# 1) specify system administrators
+# 2) set SECRET_KEY to a random string
+# 3) configure database settings (optional)
+# 4) confirm installation and data paths (optional)
+sudo $EDITOR /opt/dashboard/stable/dashboard_server/local_settings.py
+# Note: here the system will interact with your database, if you configured
+# something else than the default (sqlite) you must ensure that appropriate
+# permissions are granted in advance.
+# Note: if this is your first installation you will be prompted to create an
+# administrator account. You should do so now. If you miss this step somehow
+# you can issue 'createsuperuser' (instead of syncdb) command later. 
+sudo -u www-data /opt/dashboard/stable/dashboard_server/manage.py syncdb
+
+# Tweak to your preference, default is to have a *:80/dashboard/ virtual host
+# Most likely you will want to change this, note that you _MUST_
+# change local_settings.py if you want to choose another location for
+# the dashboard (eg http://hostname/ vs http://hostname/dashboard/)
+sudo cp /opt/dashboard/stable/dashboard_server/apache.conf /etc/apache2/sites-available/dashboard
+sudo $EDITOR /etc/apache2/sites-available/dashboard
+
+# Enable dashboard app and restart apache
+sudo a2ensite dashboard
+sudo service apache restart
+
+
+First run
+=========
+
+Now go to http://your-site/dashboard/admin and sign-in with the username and
+password you provided at syncdb or createsuperuser step. Before the system can
+be used you must create an anonymous bundle stream. You can do this by
+selecting "Bundle Streams" "Add" and "Save" from the admin panel.

=== modified file 'dashboard_server/default_settings.py'
--- dashboard_server/default_settings.py	2010-09-22 19:31:02 +0000
+++ dashboard_server/default_settings.py	2010-09-30 08:47:43 +0000
@@ -73,6 +73,9 @@
 # to load the internationalization machinery.
 USE_I18N = True
 
+# Turn off application debugging
+DEBUG = False
+
 # Turn on to enable template debugging.
 TEMPLATE_DEBUG = False
 
@@ -110,3 +113,5 @@
     'django.contrib.databrowse',
     'dashboard_app',
 )
+
+SERVE_ASSETS_FROM_DJANGO = False

=== added file 'dashboard_server/development_settings.py'
--- dashboard_server/development_settings.py	1970-01-01 00:00:00 +0000
+++ dashboard_server/development_settings.py	2010-09-30 08:47:43 +0000
@@ -0,0 +1,59 @@
+# Copyright (C) 2010 Linaro Limited
+#
+# Author: Zygmunt Krynicki <[e-mail]>
+#
+# This file is part of Launch Control.
+#
+# Launch Control is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License version 3
+# as published by the Free Software Foundation
+#
+# Launch Control is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Launch Control.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Development settings module.
+
+Suitable for local deployments (local = not on the open web) as well as
+hacking. Uses sqlite database and slow/inefficient web server built
+right into Django.
+"""
+
+import os
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+
+# Database setup
+DATABASE_ENGINE = 'sqlite3'
+DATABASE_NAME = os.path.join(BASE_DIR, 'database.db')
+
+# Static files are served directly from the source tree
+MEDIA_ROOT = os.path.join(BASE_DIR, "media")
+# Static files are accessible as /site_media/ URL
+MEDIA_URL = '/site_media/'
+
+# Development mode, turn on debugging
+# Note: debugging sucks memory as it retains SQL history _FOREVER_
+# If you _really_ want to use this for local deployment please turn
+# this off.
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+
+# List of people that get emailed when the site breaks and DEBUG is off.
+# Requires working email configuration
+ADMINS = ()
+
+# Secret key for doing secret stuff with cookies and session IDs
+SECRET_KEY = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+
+# Information for urls.py that we should serve assets without the help
+# of an external web server. This is only used when we cannot count on
+# static media files being served by some real web server. WARNING: this
+# is not secure and should _never_ be used in production environments.
+# See:
+# http://docs.djangoproject.com/en/1.2/howto/static-files/#the-big-fat-disclaimer)
+SERVE_ASSETS_FROM_DJANGO = True

=== modified file 'dashboard_server/local_settings.py.example'
--- dashboard_server/local_settings.py.example	2010-09-22 19:53:28 +0000
+++ dashboard_server/local_settings.py.example	2010-09-30 08:47:43 +0000
@@ -11,6 +11,3 @@
 MEDIA_ROOT = "/srv/dashboard/media/"
 MEDIA_URL = '/dashboard/media/'
 ADMIN_MEDIA_PREFIX = '/dashboard/admin/media/'
-
-DEBUG = False
-CONFIGURED = True

=== modified file 'dashboard_server/settings.py'
--- dashboard_server/settings.py	2010-09-22 19:31:02 +0000
+++ dashboard_server/settings.py	2010-09-30 08:47:43 +0000
@@ -17,39 +17,22 @@
 # along with Launch Control.  If not, see <http://www.gnu.org/licenses/>.
 
 """
-Settings module suitable for development
+Dashboard server settings module.
 """
 
 # CONFIGURATION
 # =============
 #
-# To configure the server create local_settings.py and change the
-# following line from `CONFIGURED = False' to `CONFIGURED = True'.
-#
-# Look at default_settings.py for explanation on what can be changed.
-#
-# When this is False a very simple configuration is created that allows
-# you to run the server directly from the development environment.
-CONFIGURED = False
-
+# To configure the server create local_settings.py and add any django
+# configuration options you care about. Please look at
+# local_settings.py.example to get started.
+#
 # DO NOT CHANGE SETTINGS BELOW
 # ============================
+
 from default_settings import *
 
-if not CONFIGURED:
-    DATABASE_ENGINE = 'sqlite3'
-    DATABASE_NAME = os.path.join(BASE_DIR, 'database.db')
-    MEDIA_ROOT = os.path.join(BASE_DIR, "media")
-    MEDIA_URL = '/site_media/'
-    DEBUG = True
-    TEMPLATE_DEBUG = DEBUG
-    ADMINS = ()
-    SECRET_KEY = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-    try:
-        # You still might want this to configure email and
-        # administration stuff. I do this for development 
-        from local_settings import *
-    except ImportError:
-        pass
-else:
+try:
     from local_settings import *
+except ImportError:
+    from development_settings import *

=== modified file 'dashboard_server/urls.py'
--- dashboard_server/urls.py	2010-09-23 01:56:08 +0000
+++ dashboard_server/urls.py	2010-09-30 08:47:43 +0000
@@ -69,12 +69,7 @@
     (r'^admin/', include(admin.site.urls)),
     )
 
-if not settings.CONFIGURED:
-    # This is only used when we cannot count on static media files being
-    # served by some real web server. WARNING: this is not secure and
-    # should _never_ be used in production environments.
-    # See:
-    # http://docs.djangoproject.com/en/1.2/howto/static-files/#the-big-fat-disclaimer)
+if settings.SERVE_ASSETS_FROM_DJANGO:
     urlpatterns += patterns('',
             (r'^site_media/(?P<path>.*)$', 'django.views.static.serve', {
                 'document_root': settings.MEDIA_ROOT,