Wiki Deployment

Wiki Systems

Public Wikis

• wiki.softxs.ch/softxs - SoftXS GmbH corporate web site

• wiki.softxs.ch/drawmgt - DrawMGT User and Administrator Documentation Wiki

• wiki.softxs.ch/intern - DrawMGT development Wiki (this Wiki)

• wiki.softxs.ch/test - Test Wiki

Project Wikis

• wiki.softxs.ch/linthal - Linthal 2015 Project Wiki

• wiki.softxs.ch/met - MET / Budapest Metro Line 4 Project Wiki

• wiki.softxs.ch/ndd - Nant de Drance Wiki

Wiki Deployment Notes

The Internet accessible Wikis are:

1. Instances of the MoinMoin wiki software

   1. MoinMoin is implemented in Python

   2. Version 1.6.1 is installed on lu.softxs.ch
2. All wikis run in a vitual host wiki.softxs.ch
   1. You need to add a some configuration information to httpd.conf each time you add a new wiki

Deployment of MoinMoin 1.6.1 on lu.softxs.ch

Had to modify the createinstance.sh script:

• vi createinstance.sh
  
  # Change the following in the script:
  
  Change
  #!/bin/bash
  To
  #!/usr/local/bin/bash
  
  #Change
  SHARE=/usr/share/moin
  #To
  SHARE=/usr/local/share/moin
  
  USER=www
  GROUP=www
  
  # Change
  chown -R $USER.$GROUP $INSTANCE
  # To
  chown -R ${USER}:${GROUP} $INSTANCE
  :x

Example: Deployment of the Wiki Instance for MET

Install Wiki Software

On lu.softxs.ch as user root:

Note that we define shell variables to make this a slightly more generic script.

• export INSTANCE=met
  
  export PREFIX=/usr/local
  export SHARE=${PREFIX}/share/moin
  export WIKILOCATION=/home/wiki/www/html
  
  export USER=wiki
  export GROUP=www
  
  cd $WIKILOCATION
  mkdir $INSTANCE                             # directory for this instance
  cp -R $SHARE/data $INSTANCE                 # template data directory
  cp -R $SHARE/underlay $INSTANCE             # underlay data directory
  cp $SHARE/config/wikiconfig.py $INSTANCE    # copy wiki cfg sample file
  
  chown -R $USER:$GROUP $INSTANCE
  chmod -R ug+rwX $INSTANCE                   # USER.GROUP may read and write
  chmod -R o-rwx $INSTANCE                    # everybody else is rejected
  
  cd $WIKILOCATION/$INSTANCE
  mkdir cgi-bin
  cp $SHARE/server/moin.cgi cgi-bin
  chown -R $USER:$GROUP cgi-bin
  chmod -R ug+rx cgi-bin
  chmod -R o-rwx cgi-bin
  
  vi cgi-bin/moin.cgi
  # Add the following line (after the 'import sys' line)
  sys.path.insert(0,'/home/wiki/www/html/met')
  :x

Wiki Instance Configuration

Update the wikiconfig.py file:

Make the following changes:

• coding ISO-8859-1 --> UTF-8

• sitename

• paths for data_dir and data_underlying_dir

• superuser -- define Alan, Tibor, Rami

• permissions: acl_rights_before and acl_rights_default -- Sets immutable pages to public

• navigation bar array: navi_bar -- defines quick links

• page footer

Differences between the original and updated files are shown:

• cd $WIKILOCATION/$INSTANCE
  
  diff wikiconfig.py-ORIG wikiconfig.py
  1c1
  < # -*- coding: iso-8859-1 -*-
  ---
  > # -*- coding: utf-8 -*-
  36c36
  <     sitename = u'Untitled Wiki'
  ---
  >     sitename = u'SoftXS GmbH - Matrics Experts Team Project Wiki'
  41c41,42
  <     logo_string = u'<img src="/moin_static171/common/moinmoin.png" alt="MoinMoin Logo">'
  ---
  >     #logo_string = u'<img src="/header.png" alt="SoftXS Logo">'
  >     logo_string = u'<img src="/moin_static171/common/softxs-logo.gif" alt="SoftXS Logo">'
  46c47
  <     #page_front_page = u"MyStartingPage"
  ---
  >     page_front_page = u"Home"
  68c69
  <     data_dir = './data/'
  ---
  >     data_dir = '/home/wiki/www/html/met/data/'
  75c76
  <     data_underlay_dir = './underlay/'
  ---
  >     data_underlay_dir = '/home/wiki/www/html/met/underlay/'
  91c92
  <     #superuser = [u"YourName", ]
  ---
  >     superuser = [u"AlanHodgkinson", u"TiborNagy", u"RamiMolander"]
  97a99,106
  >     acl_rights_before = ( u'AlanHodgkinson:read,write,delete,revert,admin '
  >                           u'TiborNagy:read,write,delete,revert,admin '
  >                           u'RamiMolander:read,write,delete,revert,admin '
  >                           u'WikiAdmin:read,write,delete,revert,admin '
  >                           u'EditorsGroup:read,write,delete,revert ')
  > 
  >     acl_rights_default = u'All:read '
  > 
  114c123
  <     #mail_smarthost = ""
  ---
  >     mail_smarthost = "smtp.softxs.ch"
  117c126
  <     #mail_from = u""
  ---
  >     mail_from = u"MET Wiki <met@softxs.ch>"
  134c143,145
  <         u'RecentChanges',
  ---
  >         u'Home',
  >         u'Checklists',
  >         u'FAQ',
  136d146
  <         u'HelpContents',
  142d151
  < 
  167a177,179
  > 
  >     page_footer1 = u'Copyright 2008-2009, SoftXS GmbH, Switzerland'

Update the Apache Configuration

• vi /usr/local/etc/apache2/httpd.conf
  
  # In the viutual host section for wiki.softxs.ch add the following:
  
    ScriptAlias /met     /home/wiki/www/html/met/cgi-bin/moin.cgi
  
  # Add a new directory for the wiki:
  
  <Directory /home/wiki/www/html/met/cgi-bin>
    Options None
    AllowOverride AuthConfig Limit
    Order allow,deny
    Allow from all
  </Directory>

Restart apache

Configuration htaccess based password protection

• cat <<__END__
  AuthUserFile /home/wiki/www/html/met/.htpassword
  AuthGroupFile /dev/null
  AuthName "SoftXS GmbH - Matrics Experts Team Project Wiki"
  AuthType Basic
  
  <Limit GET POST>
    require valid-user
  </Limit>
  __END__
  
  touch .htpassword
  htpasswd .htpassword met

Wiki Backup

TODO

Notes and Ideas

1. There is a FreBSD port: p5-HTML-WikiConverter-MoinMoin, which claims to be able to convert HTML into MoinMoin markup.

Installing MoinMoin, Single User Installation, Setup on MacOS X

MoinMoin Installation

1. Download MoinMoin and unpack.

2. Follow install instructions moin-{version}/docs/INSTALL.html

How to start the wiki server after quick install

•   # go to moinmoin directory
    cd ~/Downloads/moin-{version}
    # run wikiserver.py
    python wikiserver.py

Point browser to http://localhost:8080/

Installing DocBook Export Action

Requirements

The following software is required in order to make the DocBook Export Action work:

• Apple Developer Tools
• Xcode 3.1

1. Download MacPorts and install

2. restart
3. run the following commands ...

  sudo port install py-xml
  sudo port install python_select
  sudo port select python python24

You should now be able to use the export action.

More info: http://reality-and-a-half.multiversum.com/2010/11/docbook-export-in-moinmoin-wiki-running-on-mac-os-x-10-6-snow-leopard/