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/2.0/chapter12/
   7
   8 You'll need the following (applications used for patchwork development are
   9 in brackets):
  10
  11   * A python interpreter
  12   * django >= 1.2
  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     As an alternative, you can use password-based login and a single database
  33     account. This is described further down.
  34
  35     For PostgreSQL (ident-based)
  36
  37         $ createdb patchwork
  38         $ createuser www-data
  39         $ createuser nobody
  40
  41         - postgres uses the standard UNIX authentication, so these users
  42           will only be accessible for processes running as the same username.
  43           This means that no passwords need to be set.
  44
  45     For PostgreSQL (password-based)
  46
  47         $ createuser -PE patchwork
  48         $ createdb -O patchwork patchwork
  49
  50         Once that is done, you need to tell Django about the new Database
  51         settings, using local_settings.py (see below) to override the defaults
  52         in settings.py:
  53
  54         DATABASE_ENGINE = 'postgresql_psycopg2'
  55         DATABASE_NAME = 'patchwork'
  56         DATABASE_USER = 'patchwork'
  57         DATABASE_PASSWORD = 'my_secret_password
  58         DATABASE_HOST = 'localhost'
  59         DATABASE_PORT = ''
  60
  61     For MySQL:
  62         $ mysql
  63         > CREATE DATABASE 'patchwork';
  64         > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
  65         > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
  66
  67 2. Django setup
  68
  69         Set up some initial directories in the patchwork base directory:
  70
  71          mkdir -p lib/packages lib/python
  72
  73         lib/packages is for stuff we'll download, lib/python is to add
  74         to our python path. We'll symlink python modules into lib/python.
  75
  76         At the time of release, patchwork depends on django version 1.2 or
  77         later. Your distro probably provides this. If not, do a:
  78
  79          cd lib/packages
  80          svn checkout http://code.djangoproject.com/svn/django/tags/releases/1.2
  81          cd ../python
  82          ln -s ../packages/django/django ./django
  83
  84         The settings.py file contains default settings for patchwork, you'll
  85         need to configure settings for your own setup.
  86
  87         Rather than edit settings.py, create a file 'local_settings.py', and
  88         override or add settings as necessary. You'll need to define the
  89         following:
  90
  91           SECRET_KEY
  92           ADMINS
  93           TIME_ZONE
  94           LANGUAGE_CODE
  95           DEFAULT_FROM_EMAIL
  96           NOTIFICATION_FROM_EMAIL
  97
  98         You can generate the SECRET_KEY with the following python code:
  99
 100           import string, random
 101           chars = string.letters + string.digits + string.punctuation
 102           print repr("".join([random.choice(chars) for i in range(0,50)]))
 103
 104         If you have patchwork installed in somewhere other than /srv/patchwork,
 105         you'll also need to define:
 106
 107           MEDIA_ROOT
 108           TEMPLATE_DIRS
 109
 110         If you wish to enable the XML-RPC interface, add the following to
 111         your local_settings.py file:
 112
 113           ENABLE_XMLRPC = True
 114
 115         Then, get patchwork to create its tables in your configured database:
 116
 117          cd apps/
 118          PYTHONPATH=../lib/python ./manage.py syncdb
 119
 120         And add privileges for your mail and web users. This is only needed if
 121         you use the ident-based approach. If you use password-based database
 122         authentication, you can skip this step.
 123
 124         Postgresql:
 125           psql -f lib/sql/grant-all.postgres.sql patchwork
 126
 127         MySQL:
 128           mysql patchwork < lib/sql/grant-all.mysql.sql
 129
 130
 131 3. Apache setup
 132
 133 Example apache configuration files are in lib/apache2/.
 134
 135 wsgi:
 136         django has built-in support for WSGI, which supersedes the fastcgi
 137         handler. It is thus the preferred method to run patchwork.
 138
 139         The necessary configuration for Apache2 may be found in
 140
 141          lib/apache2/patchwork.wsgi.conf.
 142
 143         You will need to install/enable mod_wsgi for this to work:
 144
 145          a2enmod wsgi
 146          apache2ctl restart
 147
 148 mod_python:
 149
 150         An example apache configuration file for mod_python is in:
 151
 152           lib/apache2/patchwork.mod_python.conf
 153
 154         However, mod_python and mod_php may not work well together. So, if your
 155         web server is used for serving php files, the fastcgi method may suit
 156         instead.
 157
 158 fastcgi:
 159
 160         django has built-in support for fastcgi, which requires the
 161         'flup' python module. An example configuration is in:
 162
 163           lib/apache2/patchwork.fastcgi.conf
 164
 165         - this also requires the mod_rewrite apache module to be loaded.
 166
 167         Once you have apache set up, you can start the fastcgi server with:
 168
 169           cd /srv/patchwork/apps
 170           ./manage.py runfcgi method=prefork \
 171                               socket=/srv/patchwork/var/fcgi.sock \
 172                               pidfile=/srv/patchwork/var/fcgi.pid
 173
 174 4. Configure patchwork
 175     Now, you should be able to administer patchwork, by visiting the
 176     URL:
 177
 178       http://your-host/admin/
 179
 180     You'll probably want to do the following:
 181
 182       * Set up your projects
 183       * Configure your website address (in the Sites) section of the admin
 184
 185 5. Subscribe a local address to the mailing list
 186
 187      You will need an email address for patchwork to receive email on - for
 188      example - patchwork@, and this address will need to be subscribed to the
 189      list. Depending on the mailing list, you will probably need to confirm the
 190      subscription - temporarily direct the alias to yourself to do this.
 191
 192 6. Setup your MTA to deliver mail to the parsemail script
 193
 194     Your MTA will need to deliver mail to the parsemail script in the email/
 195     directory. (Note, do not use the parsemail.py script directly). Something
 196     like this in /etc/aliases is suitable for postfix:
 197
 198       patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
 199
 200     You may need to customise the parsemail.sh script if you haven't installed
 201     patchwork in /srv/patchwork.
 202
 203     Test that you can deliver a patch to this script:
 204
 205      sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
 206
 207
 208 Some errors:
 209
 210 * __init__() got an unexpected keyword argument 'max_length'
 211
 212  - you're running an old version of django. If your distribution doesn't
 213    provide a newer version, just download and extract django into
 214    lib/python/django
 215
 216 * ERROR: permission denied for relation patchwork_...
 217
 218  - the user that patchwork is running as (ie, the user of the web-server)
 219    doesn't have access to the patchwork tables in the database. Check that
 220    your web-server user exists in the database, and that it has permissions
 221    to the tables.
 222
 223 * pwclient fails for actions that require authentication, but a username
 224   and password is given int ~/.pwclient rc. Server reports "No authentication
 225   credentials given".
 226
 227  - if you're using the FastCGI interface to apache, you'll need the
 228    '-pass-header Authorization' option to the FastCGIExternalServer
 229    configuration directive.