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   * django
  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://bitbucket.org/ubernostrum/django-registration/
  65
  66          cd lib/packages/
  67          hg clone http://bitbucket.org/ubernostrum/django-registration/
  68          cd ../../apps
  69          ln -s ../lib/packages/django-registration/registration ./registration
  70
  71                 We also use some Javascript libraries:
  72
  73                  cd lib/packages
  74                  mkdir jquery
  75                  cd jquery
  76                  wget http://jqueryjs.googlecode.com/files/jquery-1.3.min.js
  77                  wget http://www.isocra.com/articles/jquery.tablednd_0_5.js.zip
  78                  unzip jquery.tablednd_0_5.js.zip jquery.tablednd_0_5.js
  79                  cd ../../../htdocs/js/
  80                  ln -s ../../lib/packages/jquery/jquery-1.3.min.js ./
  81                  ln -s ../../lib/packages/jquery/jquery.tablednd_0_5.js ./
  82
  83         The settings.py file contains default settings for patchwork, you'll
  84         need to configure settings for your own setup.
  85
  86         Rather than edit settings.py, create a file 'local_settings.py', and
  87         override or add settings as necessary. You'll need to define the
  88         following:
  89
  90           SECRET_KEY
  91           ADMINS
  92           TIME_ZONE
  93           LANGUAGE_CODE
  94
  95         You can generate the SECRET_KEY with the following python code:
  96
  97           import string, random
  98           chars = string.letters + string.digits + string.punctuation
  99           print repr("".join([random.choice(chars) for i in range(0,50)]))
 100
 101         If you have patchwork installed in somewhere other than /srv/patchwork,
 102         you'll also need to define:
 103
 104           MEDIA_ROOT
 105           TEMPLATE_DIRS
 106
 107         If you wish to enable the XML-RPC interface, add the following to
 108         your local_settings.py file:
 109
 110           ENABLE_XMLRPC = True
 111
 112         Then, get patchwork to create its tables in your configured database:
 113
 114          cd apps/
 115          PYTHONPATH=../lib/python ./manage.py syncdb
 116
 117         And add privileges for your mail and web users:
 118
 119         Postgresql:
 120           psql -f lib/sql/grant-all.postgres.sql patchwork
 121
 122         MySQL:
 123           mysql patchwork < lib/sql/grant-all.mysql.sql
 124
 125
 126 3. Apache setup
 127
 128 Example apache configuration files are in lib/apache/.
 129
 130 mod_python:
 131
 132         This should be the simpler of the two to set up. An example apache
 133         configuration file is in:
 134
 135           lib/apache/patchwork.mod_python.conf
 136
 137         However, mod_python and mod_php may not work well together. So, if your
 138         web server is used for serving php files, the fastcgi method may suit
 139         instead.
 140
 141 fastcgi:
 142
 143         django has built-in support for fastcgi, which requires the
 144         'flup' python module. An example configuration is in:
 145
 146           lib/apache/patchwork.fastcgi.conf
 147
 148         - this also requires the mod_rewrite apache module to be loaded.
 149
 150         Once you have apache set up, you can start the fastcgi server with:
 151
 152           cd /srv/patchwork/apps
 153           ./manage.py runfcgi method=prefork \
 154                               socket=/srv/patchwork/var/fcgi.sock \
 155                               pidfile=/srv/patchwork/var/fcgi.pid
 156
 157 4. Configure patchwork
 158     Now, you should be able to administer patchwork, by visiting the
 159     URL:
 160
 161       http://your-host/admin/
 162
 163     You'll probably want to do the following:
 164
 165       * Set up your projects
 166       * Configure your website address (in the Sites) section of the admin
 167
 168 5. Subscribe a local address to the mailing list
 169
 170      You will need an email address for patchwork to receive email on - for
 171      example - patchwork@, and this address will need to be subscribed to the
 172      list. Depending on the mailing list, you will probably need to confirm the
 173      subscription - temporarily direct the alias to yourself to do this.
 174
 175 6. Setup your MTA to deliver mail to the parsemail script
 176
 177     Your MTA will need to deliver mail to the parsemail script in the email/
 178     directory. (Note, do not use the parsemail.py script directly). Something
 179     like this in /etc/aliases is suitable for postfix:
 180
 181       patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
 182
 183     You may need to customise the parsemail.sh script if you haven't installed
 184     patchwork in /srv/patchwork.
 185
 186     Test that you can deliver a patch to this script:
 187
 188      sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
 189
 190
 191 Some errors:
 192
 193 * __init__() got an unexpected keyword argument 'max_length'
 194
 195  - you're running an old version of django. If your distribution doesn't
 196    provide a newer version, just download and extract django into
 197    lib/python/django
 198
 199 * ERROR: permission denied for relation patchwork_...
 200
 201  - the user that patchwork is running as (ie, the user of the web-server)
 202    doesn't have access to the patchwork tables in the database. Check that
 203    your web-server user exists in the database, and that it has permissions
 204    to the tables.
 205
 206 * pwclient fails for actions that require authentication, but a username
 207   and password is given int ~/.pwclient rc. Server reports "No authentication
 208   credentials given".
 209
 210  - if you're using the FastCGI interface to apache, you'll need the
 211    '-pass-header Authorization' option to the FastCGIExternalServer
 212    configuration directive.