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         At the time of initial release, patchwork depends on a svn version of
  51         django. I've been using svn commit 7854 - but anything after this
  52         point should be fine. If your distribution provides a sufficiently
  53         recent version of django, you can use that; if not, do a:
  54
  55          cd lib/packages
  56          svn checkout http://code.djangoproject.com/svn/django/trunk django
  57          cd ../python
  58          ln -s ../packages/django/django ./django
  59
  60         We also use the django-registration infrastructure from
  61         http://code.google.com/p/django-registration/
  62
  63          cd lib/packages/
  64          svn checkout \
  65              http://django-registration.googlecode.com/svn/trunk/registration/ \
  66              django-registration
  67          cd ../../apps
  68          ln -s ../lib/packages/django-registration ./registration
  69
  70         The settings.py file contains default settings for patchwork, you'll
  71         need to configure settings for your own setup.
  72
  73         Rather than edit settings.py, create a file 'local_settings.py', and
  74         override or add settings as necessary. You'll need to define the
  75         following:
  76
  77           SECRET_KEY
  78           ADMINS
  79           TIME_ZONE
  80           LANGUAGE_CODE
  81
  82         You can generate the SECRET_KEY with the following python code:
  83
  84           import string, random
  85           chars = string.letters + string.digits + string.punctuation
  86           print repr("".join([random.choice(chars) for i in range(0,50)]))
  87
  88         If you have patchwork installed in somewhere other than /srv/patchwork,
  89         you'll also need to define:
  90
  91           MEDIA_ROOT
  92           TEMPLATE_DIRS
  93
  94         If you wish to enable the XML-RPC interface, add the following to
  95         your local_settings.py file:
  96
  97           ENABLE_XMLRPC = True
  98
  99         Then, get patchwork to create its tables in your configured database:
 100
 101          cd apps/
 102          PYTHONPATH=../lib/python ./manage.py syncdb
 103
 104         And add privileges for your mail and web users:
 105
 106         Postgresql:
 107           psql -f lib/sql/grant-all.postgres.sql patchwork
 108
 109         MySQL:
 110           mysql patchwork < lib/sql/grant-all.mysql.sql
 111
 112
 113 3. Apache setup
 114
 115 Example apache configuration files are in lib/apache/.
 116
 117 mod_python:
 118
 119         This should be the simpler of the two to set up. An example apache
 120         configuration file is in:
 121
 122           lib/apache/patchwork.mod_python.conf
 123
 124         However, mod_python and mod_php may not work well together. So, if your
 125         web server is used for serving php files, the fastcgi method may suit
 126         instead.
 127
 128 fastcgi:
 129
 130         django has built-in support for fastcgi, which requires the
 131         'flup' python module. An example configuration is in:
 132
 133           lib/apache/patchwork.fastcgi.conf
 134
 135         - this also requires the mod_rewrite apache module to be loaded.
 136
 137         Once you have apache set up, you can start the fastcgi server with:
 138
 139           cd /srv/patchwork/apps
 140           ./manage.py runfcgi method=prefork \
 141                               socket=/srv/patchwork/var/fcgi.sock \
 142                               pidfile=/srv/patchwork/var/fcgi.pid
 143
 144 4. Configure patchwork
 145     Now, you should be able to administer patchwork, by visiting the
 146     URL:
 147
 148       http://your-host/admin/
 149
 150     You'll probably want to do the following:
 151
 152       * Set up your projects
 153       * Configure your website address (in the Sites) section of the admin
 154
 155 5. Subscribe a local address to the mailing list
 156
 157      You will need an email address for patchwork to receive email on - for
 158      example - patchwork@, and this address will need to be subscribed to the
 159      list. Depending on the mailing list, you will probably need to confirm the
 160      subscription - temporarily direct the alias to yourself to do this.
 161
 162 6. Setup your MTA to deliver mail to the parsemail script
 163
 164     Your MTA will need to deliver mail to the parsemail script in the email/
 165     directory. (Note, do not use the parsemail.py script directly). Something
 166     like this in /etc/aliases is suitable for postfix:
 167
 168       patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
 169
 170     You may need to customise the parsemail.sh script if you haven't installed
 171     patchwork in /srv/patchwork.
 172
 173     Test that you can deliver a patch to this script:
 174
 175      sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
 176
 177
 178 Some errors:
 179
 180 * __init__() got an unexpected keyword argument 'max_length'
 181
 182  - you're running an old version of django. If your distribution doesn't
 183    provide a newer version, just download and extract django into
 184    lib/python/django
 185
 186 * ERROR: permission denied for relation patchwork_...
 187
 188  - the user that patchwork is running as (ie, the user of the web-server)
 189    doesn't have access to the patchwork tables in the database. Check that
 190    your web-server user exists in the database, and that it has permissions
 191    to the tables.