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 At the time of initial release, patchwork depends on a svn version of
51 django. I've been using svn commit 7854 - but anything after this
52 point should be fine. If your distribution provides a sufficiently
53 recent version of django, you can use that; if not, do a:
56 svn checkout http://code.djangoproject.com/svn/django/trunk django
58 ln -s ../packages/django/django ./django
60 We also use the django-registration infrastructure from
61 http://code.google.com/p/django-registration/
65 http://django-registration.googlecode.com/svn/trunk/registration/ \
68 ln -s ../lib/packages/django-registration ./registration
70 The settings.py file contains default settings for patchwork, you'll
71 need to configure settings for your own setup.
73 Rather than edit settings.py, create a file 'local_settings.py', and
74 override or add settings as necessary. You'll need to define the
82 You can generate the SECRET_KEY with the following python code:
85 chars = string.letters + string.digits + string.punctuation
86 print repr("".join([random.choice(chars) for i in range(0,50)]))
88 If you have patchwork installed in somewhere other than /srv/patchwork,
89 you'll also need to define:
94 If you wish to enable the XML-RPC interface, add the following to
95 your local_settings.py file:
99 Then, get patchwork to create its tables in your configured database:
102 PYTHONPATH=../lib/python ./manage.py syncdb
104 And add privileges for your mail and web users:
107 psql -f lib/sql/grant-all.postgres.sql patchwork
110 mysql patchwork < lib/sql/grant-all.mysql.sql
115 Example apache configuration files are in lib/apache/.
119 This should be the simpler of the two to set up. An example apache
120 configuration file is in:
122 lib/apache/patchwork.mod_python.conf
124 However, mod_python and mod_php may not work well together. So, if your
125 web server is used for serving php files, the fastcgi method may suit
130 django has built-in support for fastcgi, which requires the
131 'flup' python module. An example configuration is in:
133 lib/apache/patchwork.fastcgi.conf
135 - this also requires the mod_rewrite apache module to be loaded.
137 Once you have apache set up, you can start the fastcgi server with:
139 cd /srv/patchwork/apps
140 ./manage.py runfcgi method=prefork \
141 socket=/srv/patchwork/var/fcgi.sock \
142 pidfile=/srv/patchwork/var/fcgi.pid
144 4. Configure patchwork
145 Now, you should be able to administer patchwork, by visiting the
148 http://your-host/admin/
150 You'll probably want to do the following:
152 * Set up your projects
153 * Configure your website address (in the Sites) section of the admin
155 5. Subscribe a local address to the mailing list
157 You will need an email address for patchwork to receive email on - for
158 example - patchwork@, and this address will need to be subscribed to the
159 list. Depending on the mailing list, you will probably need to confirm the
160 subscription - temporarily direct the alias to yourself to do this.
162 6. Setup your MTA to deliver mail to the parsemail script
164 Your MTA will need to deliver mail to the parsemail script in the email/
165 directory. (Note, do not use the parsemail.py script directly). Something
166 like this in /etc/aliases is suitable for postfix:
168 patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
170 You may need to customise the parsemail.sh script if you haven't installed
171 patchwork in /srv/patchwork.
173 Test that you can deliver a patch to this script:
175 sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
180 * __init__() got an unexpected keyword argument 'max_length'
182 - you're running an old version of django. If your distribution doesn't
183 provide a newer version, just download and extract django into
186 * ERROR: permission denied for relation patchwork_...
188 - the user that patchwork is running as (ie, the user of the web-server)
189 doesn't have access to the patchwork tables in the database. Check that
190 your web-server user exists in the database, and that it has permissions