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.
32 As an alternative, you can use password-based login and a single database
33 account. This is described further down.
35 For PostgreSQL (ident-based)
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.
45 For PostgreSQL (password-based)
47 $ createuser -PE patchwork
48 $ createdb -O patchwork patchwork
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
54 DATABASE_ENGINE = 'postgresql_psycopg2'
55 DATABASE_NAME = 'patchwork'
56 DATABASE_USER = 'patchwork'
57 DATABASE_PASSWORD = 'my_secret_password
58 DATABASE_HOST = 'localhost'
63 > CREATE DATABASE 'patchwork';
64 > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
65 > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
69 Set up some initial directories in the patchwork base directory:
71 mkdir -p lib/packages lib/python
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.
76 At the time of release, patchwork depends on django version 1.0 or
77 later. Your distro probably provides this. If not, do a:
80 svn checkout http://code.djangoproject.com/svn/django/tags/releases/1.2
82 ln -s ../packages/django/django ./django
84 We also use some Javascript libraries:
89 wget http://jqueryjs.googlecode.com/files/jquery-1.3.min.js
90 wget http://www.isocra.com/articles/jquery.tablednd_0_5.js.zip
91 unzip jquery.tablednd_0_5.js.zip jquery.tablednd_0_5.js
92 cd ../../../htdocs/js/
93 ln -s ../../lib/packages/jquery/jquery-1.3.min.js ./
94 ln -s ../../lib/packages/jquery/jquery.tablednd_0_5.js ./
96 The settings.py file contains default settings for patchwork, you'll
97 need to configure settings for your own setup.
99 Rather than edit settings.py, create a file 'local_settings.py', and
100 override or add settings as necessary. You'll need to define the
108 You can generate the SECRET_KEY with the following python code:
110 import string, random
111 chars = string.letters + string.digits + string.punctuation
112 print repr("".join([random.choice(chars) for i in range(0,50)]))
114 If you have patchwork installed in somewhere other than /srv/patchwork,
115 you'll also need to define:
120 If you wish to enable the XML-RPC interface, add the following to
121 your local_settings.py file:
125 Then, get patchwork to create its tables in your configured database:
128 PYTHONPATH=../lib/python ./manage.py syncdb
130 And add privileges for your mail and web users. This is only needed if
131 you use the ident-based approach. If you use password-based database
132 authentication, you can skip this step.
135 psql -f lib/sql/grant-all.postgres.sql patchwork
138 mysql patchwork < lib/sql/grant-all.mysql.sql
143 Example apache configuration files are in lib/apache2/.
146 django has built-in support for WSGI, which supersedes the fastcgi
147 handler. It is thus the preferred method to run patchwork.
149 The necessary configuration for Apache2 may be found in
151 lib/apache2/patchwork.wsgi.conf.
153 You will need to install/enable mod_wsgi for this to work:
160 An example apache configuration file for mod_python is in:
162 lib/apache2/patchwork.mod_python.conf
164 However, mod_python and mod_php may not work well together. So, if your
165 web server is used for serving php files, the fastcgi method may suit
170 django has built-in support for fastcgi, which requires the
171 'flup' python module. An example configuration is in:
173 lib/apache2/patchwork.fastcgi.conf
175 - this also requires the mod_rewrite apache module to be loaded.
177 Once you have apache set up, you can start the fastcgi server with:
179 cd /srv/patchwork/apps
180 ./manage.py runfcgi method=prefork \
181 socket=/srv/patchwork/var/fcgi.sock \
182 pidfile=/srv/patchwork/var/fcgi.pid
184 4. Configure patchwork
185 Now, you should be able to administer patchwork, by visiting the
188 http://your-host/admin/
190 You'll probably want to do the following:
192 * Set up your projects
193 * Configure your website address (in the Sites) section of the admin
195 5. Subscribe a local address to the mailing list
197 You will need an email address for patchwork to receive email on - for
198 example - patchwork@, and this address will need to be subscribed to the
199 list. Depending on the mailing list, you will probably need to confirm the
200 subscription - temporarily direct the alias to yourself to do this.
202 6. Setup your MTA to deliver mail to the parsemail script
204 Your MTA will need to deliver mail to the parsemail script in the email/
205 directory. (Note, do not use the parsemail.py script directly). Something
206 like this in /etc/aliases is suitable for postfix:
208 patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
210 You may need to customise the parsemail.sh script if you haven't installed
211 patchwork in /srv/patchwork.
213 Test that you can deliver a patch to this script:
215 sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
220 * __init__() got an unexpected keyword argument 'max_length'
222 - you're running an old version of django. If your distribution doesn't
223 provide a newer version, just download and extract django into
226 * ERROR: permission denied for relation patchwork_...
228 - the user that patchwork is running as (ie, the user of the web-server)
229 doesn't have access to the patchwork tables in the database. Check that
230 your web-server user exists in the database, and that it has permissions
233 * pwclient fails for actions that require authentication, but a username
234 and password is given int ~/.pwclient rc. Server reports "No authentication
237 - if you're using the FastCGI interface to apache, you'll need the
238 '-pass-header Authorization' option to the FastCGIExternalServer
239 configuration directive.