Merge lp:~patrick-hetu/charms/oneiric/python-moinmoin/trunk into lp:charms/oneiric/python-moinmoin

[Patrick Hetu]

Added Documentation, Configurations and Gunicorn as wsgi server.

[Clint Byrum (clint-fewbar)]

Looks great patrick, thanks so much for the ongoing contributions!

review: Approve

=== added file 'README'
--- README	1970-01-01 00:00:00 +0000
+++ README	2012-01-10 18:44:23 +0000
@@ -0,0 +1,31 @@
+Juju charm python-moinmoin
+==========================
+
+:Author: Patrick Hetu <[e-mail]>
+
+Example deployment
+------------------
+
+1. Setup your wiki specific parameters in mywiki.yaml like this::
+
+    mywiki:
+      wiki_name : "My MoinMoin wiki"
+      admin_name: "Admin"
+      languages: English French
+      xapian_search: True
+
+2. Deployment with nginx::
+
+    juju bootstrap
+    juju deploy --config mywiki.yaml python-moinmoin
+    juju deploy nginx
+    juju add-relation nginx:reverseproxy python-moinmoin:website
+    juju expose nginx
+
+3. Accessing your new moinmoin wiki should be ready at::
+
+       http://<nginx-machine-addr>/ 
+
+   To find out the public address of nginx, look for it in the output of the
+   `juju status` command.  
+

=== modified file 'TODO.rst'
--- TODO.rst	2011-11-01 20:33:21 +0000
+++ TODO.rst	2012-01-10 18:44:23 +0000
@@ -1,10 +1,9 @@
 TODO
 ====
 
-* Make it possible to share the data directory between units.
-* Configure the first user
-* Configure the language
-* Configure other options (frontpage, menus, theme, permissions, etc)
-* Add relations to haproxy, nfs, etc
-* Install and configure xapian
-
+* Make it possible to share the data directory between units (nfs)
+
+ * custom directories for users, data, cache, etc
+
+* Configure Gunicorn depending on the number of CPU available
+* logging + rsyslog

=== removed directory 'apparmor'
=== modified file 'config.yaml'
--- config.yaml	2011-11-01 20:33:21 +0000
+++ config.yaml	2012-01-10 18:44:23 +0000
@@ -1,7 +1,26 @@
 options:
     wiki_name:
+        default: "My MoinMoin wiki"
         type: string
-        default: "moinmoin"
+        description: The name of your wiki.
     admin_name:
-        type: string
         default: "Admin"
+        type: string
+        description: The wiki name of the admin user.
+    languages:
+        defaut: English
+        type: string
+        description: |
+            Languages to installed in a space-separated format. 
+            For available languages see: http://moinmo.in/4ct10n/AttachFile/LanguageSetup?action=AttachFile
+            (write only the language name part)
+    xapian_search:
+        default: False
+        type: string
+        description: Set to True to enable the Xapian search engine.
+    extra_settings:
+        default: ""
+        type: string
+        description: |
+            For the list of available configuration options see: http://moinmo.in/HelpOnConfiguration.
+            Also, don't forget to starts your configuration lines with a 4 spaces indentation.

=== added file 'hooks/config-changed'
--- hooks/config-changed	1970-01-01 00:00:00 +0000
+++ hooks/config-changed	2012-01-10 18:44:23 +0000
@@ -0,0 +1,62 @@
+#!/bin/bash
+
+UNIT_NAME=`echo $JUJU_UNIT_NAME | cut -d/ -f1`
+
+WIKI_NAME=$(config-get wiki_name)
+ADMIN_NAME=$(config-get admin_name)
+LANGUAGES=$(config-get languages)
+XAPIAN_SETTINGS=$(config-get xapian_search)
+EXTRA_SETTINGS=$(config-get extra_settings)
+
+
+cat > /srv/${UNIT_NAME}/wikiconfig.py <<EOF
+# -*- coding: utf-8 -*-
+import os
+
+from MoinMoin.config import multiconfig, url_prefix_static
+
+class Config(multiconfig.DefaultConfig):
+    wikiconfig_dir = os.path.abspath(os.path.dirname(__file__))
+    instance_dir = wikiconfig_dir
+    data_dir = os.path.join(instance_dir, 'data', '') # path with trailing /
+    data_underlay_dir = os.path.join(instance_dir, 'underlay', '') # path with trailing /
+
+    sitename = u'$WIKI_NAME'
+    logo_string = u'<img src="%s/common/moinmoin.png" alt="MoinMoin Logo">' % url_prefix_static
+    superuser = [u"$ADMIN_NAME", ]
+    acl_rights_before = u"$ADMIN_NAME:read,write,delete,revert,admin"
+
+    page_front_page = u"FrontPage"
+    navi_bar = [
+        u'%(page_front_page)s',
+        u'RecentChanges',
+        u'FindPage',
+        u'HelpContents',
+    ]
+    xapian_search = ${XAPIAN_SETTINGS}
+    xapian_stemming = ${XAPIAN_SETTINGS}
+
+${EXTRA_SETTINGS}
+EOF
+
+
+if [ "$XAPIAN_SETTINGS" == "True" ] ; then
+  if [ ! -e /srv/${UNIT_NAME}/xapian_is_initialized ] ; then
+    moin --config-dir=/srv/${UNIT_NAME}/ index build --mode=add
+    touch /srv/${UNIT_NAME}/xapian_is_initialized
+  else
+    moin --config-dir=/srv/${UNIT_NAME}/ index build --mode=rebuild
+  fi
+fi
+
+cd /srv/${UNIT_NAME}/
+
+for lang in $LANGUAGES; do
+    python -m MoinMoin.packages i ./underlay/pages/LanguageSetup/attachments/${lang}--all_pages.zip
+done
+
+chown www-data /srv/${UNIT_NAME}/ -R
+chmod g+rw /srv/${UNIT_NAME}/ -R
+
+/etc/init.d/gunicorn start
+/etc/init.d/gunicorn reload

=== modified file 'hooks/install'
--- hooks/install	2011-11-01 20:33:21 +0000
+++ hooks/install	2012-01-10 18:44:23 +0000
@@ -1,93 +1,105 @@
 #!/bin/bash
 
+UNIT_NAME=`echo $JUJU_UNIT_NAME | cut -d/ -f1`
+
 WIKI_NAME=$(config-get wiki_name)
 ADMIN_NAME=$(config-get admin_name)
 
-apt-get install -y python-moinmoin fckeditor python-flup nginx gunicorn unzip --no-install-recommends
-
-mkdir -p /srv/moinmoin_site/run
-
-cp -r /usr/share/moin/data /usr/share/moin/underlay /srv/moinmoin_site/
-cp -r /usr/share/moin/htdocs /srv/moinmoin_site/moin_static
-
-cat > /srv/moinmoin_site/wsgi.py << EOF
+apt-get install -y python-moinmoin fckeditor python-flup gunicorn python-eventlet unzip python-openid python-xapian python-xappy --no-install-recommends
+
+# MoinMoin's command line script 'moin' check there first
+# and we don't want that
+rm /etc/moin/farmconfig.py
+
+mkdir -p /srv/${UNIT_NAME}/run
+mkdir -p /srv/${UNIT_NAME}/logs
+
+cp -r /usr/share/moin/data /usr/share/moin/underlay /srv/${UNIT_NAME}/
+cp -r /usr/share/moin/htdocs /srv/${UNIT_NAME}/moin_static
+
+cat > /srv/${UNIT_NAME}/wsgi.py << EOF
+import sys
+sys.path.insert(0, '/srv/${UNIT_NAME}/')
+
 from MoinMoin.web.serving import make_application
 from MoinMoin import log
 
-application = make_application()
-EOF
-
-cat > /srv/moinmoin_site/wikiconfig.py <<EOF
-# -*- coding: utf-8 -*-
-import os
-from MoinMoin.config import multiconfig, url_prefix_static
-class Config(multiconfig.DefaultConfig):
-    wikiconfig_dir = os.path.abspath(os.path.dirname(__file__))
-    instance_dir = wikiconfig_dir
-    data_dir = os.path.join(instance_dir, 'data', '') # path with trailing /
-    data_underlay_dir = os.path.join(instance_dir, 'underlay', '') # path with trailing /
-    url_prefix_static = '/moin_static'
-    sitename = u'$WIKI_NAME'
-    logo_string = u'<img src="%s/common/moinmoin.png" alt="MoinMoin Logo">' % url_prefix_static
-    superuser = [u"$ADMIN_NAME", ]
-    acl_rights_before = u"$ADMIN_NAME:read,write,delete,revert,admin"
-    navi_bar = [
-        u'%(page_front_page)s',
-        u'RecentChanges',
-        u'FindPage',
-        u'HelpContents',
-    ]
-    theme_default = 'modern'
-    language_default = 'en'
-    page_front_page = u"FrontPage"
-    page_category_regex = ur'(?P<all>Category(?P<key>(?!Template)\S+))'
-    page_dict_regex = ur'(?P<all>(?P<key>\S+)Dict)'
-    page_group_regex = ur'(?P<all>(?P<key>\S+)Group)'
-    page_template_regex = ur'(?P<all>(?P<key>\S+)Template)'
-    show_hosts = 1
-EOF
-
-cat > /etc/init/moinmoin_site.conf <<EOF
-start on (net-device-up
-          and local-filesystems
-      and runlevel [2345])
-stop on runlevel [!2345]
-
-respawn
-
-exec su -c "cd /srv/moinmoin_site/; /usr/bin/gunicorn wsgi --workers 2 --bind=unix:/srv/moinmoin_site/run/moinmoin_site_gunicorn --pid=/srv/moinmoin_site/run/moinmoin_site_gunicorn.pid" www-data
-EOF
-
-rm /etc/nginx/sites-enabled/default
-
-cat > /etc/nginx/sites-enabled/moinmoin.conf << EOF
-server {
-    listen   80; ## listen for ipv4; this line is default and implied
-    listen   [::]:80 default ipv6only=on; ## listen for ipv6
-
-    root /srv/moinmoin_site;
-
-    location / {
-        proxy_pass http://unix:/srv/moinmoin_site/run/moinmoin_site_gunicorn:;
-        proxy_set_header Host \$host;
-        proxy_set_header X-Real-IP \$remote_addr;
-        proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
-    }
-
-    location /moin_static {
-        root /srv/moinmoin_site/;
-        autoindex off;
-        expires 1M;
-    }
+log.load_config('/srv/${UNIT_NAME}/logging.conf')
+
+
+application = make_application(shared='/srv/${UNIT_NAME}/moin_static')
+EOF
+
+cat > /srv/${UNIT_NAME}/logging.conf << EOF
+[DEFAULT]
+# Logfile to create.
+# Make sure the running moin process has create/write rights there.
+logfile=/srv/${UNIT_NAME}/logs/moinmoin.log
+
+# Default loglevel, to adjust verbosity: DEBUG, INFO, WARNING, ERROR, CRITICAL
+loglevel=INFO
+
+[loggers]
+keys=root
+
+[handlers]
+keys=logfile
+
+[formatters]
+keys=logfile
+
+[logger_root]
+level=%(loglevel)s
+handlers=logfile
+
+[handler_logfile]
+class=FileHandler
+formatter=logfile
+level=%(loglevel)s
+args=('%(logfile)s', 'at')
+
+[formatter_logfile]
+format=%(levelname)s %(asctime)s %(name)s:%(lineno)d %(message)s
+datefmt=
+class=logging.Formatter
+EOF
+
+# find a free port from 80
+# FIXME: but what about closed services?
+
+PORT=8080
+quit=0
+
+while [ "$quit" -ne 1 ]; do
+    netstat -na | grep 'tcp' | grep 'LISTEN' | awk '{print $4}' | cut -d: -f2 | grep $PORT >> /dev/null
+    if [ $? -ne 0 ]
+    then
+        quit=1
+    else
+        PORT=`expr $PORT + 1`
+    fi
+done
+
+cat > /etc/gunicorn.d/${UNIT_NAME}.conf <<EOF
+CONFIG = {
+    'mode': 'wsgi',
+    'environment': {
+        'PYTHONPATH': '/srv/${UNIT_NAME}/',
+    },
+    'working_dir': '/srv/${UNIT_NAME}/',
+    'user': 'www-data',
+    'group': 'www-data',
+    'args': (
+        '--name=${UNIT_NAME}_wiki',
+        '--worker-class=eventlet',
+        '--bind=0.0.0.0:${PORT}',
+        '--workers=2',
+        '--log-file=/srv/${UNIT_NAME}/logs/gunicorn.log',
+        '--timeout=300',
+        'wsgi',
+    ),
 }
 EOF
 
-chown www-data /srv/moinmoin_site/ -R
-
-cd /srv/moinmoin_site/
-su -c "python -m MoinMoin.packages i ./underlay/pages/LanguageSetup/attachments/English--all_pages.zip" www-data
-
-start moinmoin_site
-/etc/init.d/nginx start
-
-open-port 80
+
+open-port $PORT/tcp

=== modified file 'revision'
--- revision	2011-11-01 20:33:21 +0000
+++ revision	2012-01-10 18:44:23 +0000
@@ -1,1 +1,1 @@
-4
+5