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 lib/packages is for stuff we'll download, lib/python is to add
55 to our python path. We'll symlink python modules into lib/python.
57 At the time of release, patchwork depends on django version 1.0 or
58 later. Your distro probably provides this. If not, do a:
61 svn checkout http://code.djangoproject.com/svn/django/tags/releases/1.2
63 ln -s ../packages/django/django ./django
65 We also use the django-registration infrastructure from
66 http://bitbucket.org/ubernostrum/django-registration/. Your distro
67 may provide the django-registration python module (in Ubuntu/Debian it's
68 called 'python-django-registration'). If not, download the module
69 and symlink it to lib/python/ :
72 hg clone http://bitbucket.org/ubernostrum/django-registration/
74 ln -s ../lib/packages/django-registration/registration ./registration
76 We also use some Javascript libraries:
81 wget http://jqueryjs.googlecode.com/files/jquery-1.3.min.js
82 wget http://www.isocra.com/articles/jquery.tablednd_0_5.js.zip
83 unzip jquery.tablednd_0_5.js.zip jquery.tablednd_0_5.js
84 cd ../../../htdocs/js/
85 ln -s ../../lib/packages/jquery/jquery-1.3.min.js ./
86 ln -s ../../lib/packages/jquery/jquery.tablednd_0_5.js ./
88 The settings.py file contains default settings for patchwork, you'll
89 need to configure settings for your own setup.
91 Rather than edit settings.py, create a file 'local_settings.py', and
92 override or add settings as necessary. You'll need to define the
100 You can generate the SECRET_KEY with the following python code:
102 import string, random
103 chars = string.letters + string.digits + string.punctuation
104 print repr("".join([random.choice(chars) for i in range(0,50)]))
106 If you have patchwork installed in somewhere other than /srv/patchwork,
107 you'll also need to define:
112 If you wish to enable the XML-RPC interface, add the following to
113 your local_settings.py file:
117 Then, get patchwork to create its tables in your configured database:
120 PYTHONPATH=../lib/python ./manage.py syncdb
122 And add privileges for your mail and web users:
125 psql -f lib/sql/grant-all.postgres.sql patchwork
128 mysql patchwork < lib/sql/grant-all.mysql.sql
133 Example apache configuration files are in lib/apache/.
137 This should be the simpler of the two to set up. An example apache
138 configuration file is in:
140 lib/apache/patchwork.mod_python.conf
142 However, mod_python and mod_php may not work well together. So, if your
143 web server is used for serving php files, the fastcgi method may suit
148 django has built-in support for fastcgi, which requires the
149 'flup' python module. An example configuration is in:
151 lib/apache/patchwork.fastcgi.conf
153 - this also requires the mod_rewrite apache module to be loaded.
155 Once you have apache set up, you can start the fastcgi server with:
157 cd /srv/patchwork/apps
158 ./manage.py runfcgi method=prefork \
159 socket=/srv/patchwork/var/fcgi.sock \
160 pidfile=/srv/patchwork/var/fcgi.pid
162 4. Configure patchwork
163 Now, you should be able to administer patchwork, by visiting the
166 http://your-host/admin/
168 You'll probably want to do the following:
170 * Set up your projects
171 * Configure your website address (in the Sites) section of the admin
173 5. Subscribe a local address to the mailing list
175 You will need an email address for patchwork to receive email on - for
176 example - patchwork@, and this address will need to be subscribed to the
177 list. Depending on the mailing list, you will probably need to confirm the
178 subscription - temporarily direct the alias to yourself to do this.
180 6. Setup your MTA to deliver mail to the parsemail script
182 Your MTA will need to deliver mail to the parsemail script in the email/
183 directory. (Note, do not use the parsemail.py script directly). Something
184 like this in /etc/aliases is suitable for postfix:
186 patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
188 You may need to customise the parsemail.sh script if you haven't installed
189 patchwork in /srv/patchwork.
191 Test that you can deliver a patch to this script:
193 sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
198 * __init__() got an unexpected keyword argument 'max_length'
200 - you're running an old version of django. If your distribution doesn't
201 provide a newer version, just download and extract django into
204 * ERROR: permission denied for relation patchwork_...
206 - the user that patchwork is running as (ie, the user of the web-server)
207 doesn't have access to the patchwork tables in the database. Check that
208 your web-server user exists in the database, and that it has permissions
211 * pwclient fails for actions that require authentication, but a username
212 and password is given int ~/.pwclient rc. Server reports "No authentication
215 - if you're using the FastCGI interface to apache, you'll need the
216 '-pass-header Authorization' option to the FastCGIExternalServer
217 configuration directive.