git.ozlabs.org Git - patchwork/blob - docs/INSTALL

   1 Deploying Patchwork
   2
   3 Patchwork uses the django framework - there is some background on deploying
   4 django applications here:
   5
   6  http://www.djangobook.com/en/1.0/chapter20/
   7
   8 You'll need the following (applications used for patchwork development are
   9 in brackets):
  10
  11   * A python interpreter
  12   * djano
  13   * A webserver (apache)
  14   * mod_python or flup
  15   * A database server (postgresql)
  16
  17 1. Database setup
  18
  19     At present, I've tested with PostgreSQL and (to a lesser extent) MySQL
  20     database servers. If you have any (positive or negative) experiences with
  21     either, email me.
  22
  23     For the following commands, a $ prefix signifies that the command should be
  24     entered at your shell prompt, and a > prefix signifies the commant-line
  25     client for your sql server (psql or mysql)
  26
  27     Create a database for the system, add accounts for two system users: the
  28     web user (the user that your web server runs as) and the mail user (the
  29     user that your mail server runs as). On Ubuntu these are
  30     www-data and nobody, respectively.
  31
  32     For PostgreSQL
  33
  34         $ createdb patchwork
  35         $ createuser www-data
  36         $ createuser nobody
  37
  38         - postgres uses the standard UNIX authentication, so these users
  39           will only be accessible for processes running as the same username.
  40           This means that no passwords need to be set.
  41
  42      For MySQL:
  43         $ mysql
  44         > CREATE DATABASE 'patchwork';
  45         > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
  46         > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
  47
  48 2. Django setup
  49
  50         Set up some initial directories in the patchwork base directory:
  51
  52          mkdir -p lib/packages lib/python
  53
  54         At the time of release, patchwork depends on django version 1.0.
  55         However, most distros don't provide 1.0 yet. If yours does, then you
  56         can skip this step. Otherwise, do a:
  57
  58          cd lib/packages
  59          svn checkout http://code.djangoproject.com/svn/django/tags/releases/1.0
  60          cd ../python
  61          ln -s ../packages/django/django ./django
  62
  63         We also use the django-registration infrastructure from
  64         http://code.google.com/p/django-registration/
  65
  66          cd lib/packages/
  67          svn checkout \
  68              http://django-registration.googlecode.com/svn/trunk/registration/ \
  69              django-registration
  70          cd ../../apps
  71          ln -s ../lib/packages/django-registration ./registration
  72
  73         The settings.py file contains default settings for patchwork, you'll
  74         need to configure settings for your own setup.
  75
  76         Rather than edit settings.py, create a file 'local_settings.py', and
  77         override or add settings as necessary. You'll need to define the
  78         following:
  79
  80           SECRET_KEY
  81           ADMINS
  82           TIME_ZONE
  83           LANGUAGE_CODE
  84
  85         You can generate the SECRET_KEY with the following python code:
  86
  87           import string, random
  88           chars = string.letters + string.digits + string.punctuation
  89           print repr("".join([random.choice(chars) for i in range(0,50)]))
  90
  91         If you have patchwork installed in somewhere other than /srv/patchwork,
  92         you'll also need to define:
  93
  94           MEDIA_ROOT
  95           TEMPLATE_DIRS
  96
  97         If you wish to enable the XML-RPC interface, add the following to
  98         your local_settings.py file:
  99
 100           ENABLE_XMLRPC = True
 101
 102         Then, get patchwork to create its tables in your configured database:
 103
 104          cd apps/
 105          PYTHONPATH=../lib/python ./manage.py syncdb
 106
 107         And add privileges for your mail and web users:
 108
 109         Postgresql:
 110           psql -f lib/sql/grant-all.postgres.sql patchwork
 111
 112         MySQL:
 113           mysql patchwork < lib/sql/grant-all.mysql.sql
 114
 115
 116 3. Apache setup
 117
 118 Example apache configuration files are in lib/apache/.
 119
 120 mod_python:
 121
 122         This should be the simpler of the two to set up. An example apache
 123         configuration file is in:
 124
 125           lib/apache/patchwork.mod_python.conf
 126
 127         However, mod_python and mod_php may not work well together. So, if your
 128         web server is used for serving php files, the fastcgi method may suit
 129         instead.
 130
 131 fastcgi:
 132
 133         django has built-in support for fastcgi, which requires the
 134         'flup' python module. An example configuration is in:
 135
 136           lib/apache/patchwork.fastcgi.conf
 137
 138         - this also requires the mod_rewrite apache module to be loaded.
 139
 140         Once you have apache set up, you can start the fastcgi server with:
 141
 142           cd /srv/patchwork/apps
 143           ./manage.py runfcgi method=prefork \
 144                               socket=/srv/patchwork/var/fcgi.sock \
 145                               pidfile=/srv/patchwork/var/fcgi.pid
 146
 147 4. Configure patchwork
 148     Now, you should be able to administer patchwork, by visiting the
 149     URL:
 150
 151       http://your-host/admin/
 152
 153     You'll probably want to do the following:
 154
 155       * Set up your projects
 156       * Configure your website address (in the Sites) section of the admin
 157
 158 5. Subscribe a local address to the mailing list
 159
 160      You will need an email address for patchwork to receive email on - for
 161      example - patchwork@, and this address will need to be subscribed to the
 162      list. Depending on the mailing list, you will probably need to confirm the
 163      subscription - temporarily direct the alias to yourself to do this.
 164
 165 6. Setup your MTA to deliver mail to the parsemail script
 166
 167     Your MTA will need to deliver mail to the parsemail script in the email/
 168     directory. (Note, do not use the parsemail.py script directly). Something
 169     like this in /etc/aliases is suitable for postfix:
 170
 171       patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
 172
 173     You may need to customise the parsemail.sh script if you haven't installed
 174     patchwork in /srv/patchwork.
 175
 176     Test that you can deliver a patch to this script:
 177
 178      sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
 179
 180
 181 Some errors:
 182
 183 * __init__() got an unexpected keyword argument 'max_length'
 184
 185  - you're running an old version of django. If your distribution doesn't
 186    provide a newer version, just download and extract django into
 187    lib/python/django
 188
 189 * ERROR: permission denied for relation patchwork_...
 190
 191  - the user that patchwork is running as (ie, the user of the web-server)
 192    doesn't have access to the patchwork tables in the database. Check that
 193    your web-server user exists in the database, and that it has permissions
 194    to the tables.