3 Patchwork uses the django framework - there is some background on deploying
4 django applications here:
6 http://www.djangobook.com/en/1.0/chapter20/
8 You'll need the following (applications used for patchwork development are
11 * A python interpreter
13 * A webserver (apache)
15 * A database server (postgresql)
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
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)
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.
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.
44 > CREATE DATABASE 'patchwork';
45 > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
46 > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
50 Set up some initial directories in the patchwork base directory:
52 mkdir -p lib/packages lib/python
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:
59 svn checkout http://code.djangoproject.com/svn/django/tags/releases/1.0
61 ln -s ../packages/django/django ./django
63 We also use the django-registration infrastructure from
64 http://code.google.com/p/django-registration/
68 http://django-registration.googlecode.com/svn/trunk/registration/ \
71 ln -s ../lib/packages/django-registration ./registration
73 We also use some Javascript libraries:
78 wget http://jqueryjs.googlecode.com/files/jquery-1.3.min.js
79 wget http://www.isocra.com/articles/jquery.tablednd_0_5.js.zip
80 unzip jquery.tablednd_0_5.js.zip jquery.tablednd_0_5.js
81 cd ../../../htdocs/js/
82 ln -s ../../lib/packages/jquery/jquery-1.3.min.js ./
83 ln -s ../../lib/packages/jquery/jquery.tablednd_0_5.js ./
85 The settings.py file contains default settings for patchwork, you'll
86 need to configure settings for your own setup.
88 Rather than edit settings.py, create a file 'local_settings.py', and
89 override or add settings as necessary. You'll need to define the
97 You can generate the SECRET_KEY with the following python code:
100 chars = string.letters + string.digits + string.punctuation
101 print repr("".join([random.choice(chars) for i in range(0,50)]))
103 If you have patchwork installed in somewhere other than /srv/patchwork,
104 you'll also need to define:
109 If you wish to enable the XML-RPC interface, add the following to
110 your local_settings.py file:
114 Then, get patchwork to create its tables in your configured database:
117 PYTHONPATH=../lib/python ./manage.py syncdb
119 And add privileges for your mail and web users:
122 psql -f lib/sql/grant-all.postgres.sql patchwork
125 mysql patchwork < lib/sql/grant-all.mysql.sql
130 Example apache configuration files are in lib/apache/.
134 This should be the simpler of the two to set up. An example apache
135 configuration file is in:
137 lib/apache/patchwork.mod_python.conf
139 However, mod_python and mod_php may not work well together. So, if your
140 web server is used for serving php files, the fastcgi method may suit
145 django has built-in support for fastcgi, which requires the
146 'flup' python module. An example configuration is in:
148 lib/apache/patchwork.fastcgi.conf
150 - this also requires the mod_rewrite apache module to be loaded.
152 Once you have apache set up, you can start the fastcgi server with:
154 cd /srv/patchwork/apps
155 ./manage.py runfcgi method=prefork \
156 socket=/srv/patchwork/var/fcgi.sock \
157 pidfile=/srv/patchwork/var/fcgi.pid
159 4. Configure patchwork
160 Now, you should be able to administer patchwork, by visiting the
163 http://your-host/admin/
165 You'll probably want to do the following:
167 * Set up your projects
168 * Configure your website address (in the Sites) section of the admin
170 5. Subscribe a local address to the mailing list
172 You will need an email address for patchwork to receive email on - for
173 example - patchwork@, and this address will need to be subscribed to the
174 list. Depending on the mailing list, you will probably need to confirm the
175 subscription - temporarily direct the alias to yourself to do this.
177 6. Setup your MTA to deliver mail to the parsemail script
179 Your MTA will need to deliver mail to the parsemail script in the email/
180 directory. (Note, do not use the parsemail.py script directly). Something
181 like this in /etc/aliases is suitable for postfix:
183 patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
185 You may need to customise the parsemail.sh script if you haven't installed
186 patchwork in /srv/patchwork.
188 Test that you can deliver a patch to this script:
190 sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
195 * __init__() got an unexpected keyword argument 'max_length'
197 - you're running an old version of django. If your distribution doesn't
198 provide a newer version, just download and extract django into
201 * ERROR: permission denied for relation patchwork_...
203 - the user that patchwork is running as (ie, the user of the web-server)
204 doesn't have access to the patchwork tables in the database. Check that
205 your web-server user exists in the database, and that it has permissions
208 * pwclient fails for actions that require authentication, but a username
209 and password is given int ~/.pwclient rc. Server reports "No authentication
212 - if you're using the FastCGI interface to apache, you'll need the
213 '-pass-header Authorization' option to the FastCGIExternalServer
214 configuration directive.