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 The settings.py file contains default settings for patchwork, you'll
74 need to configure settings for your own setup.
76 Rather than edit settings.py, create a file 'local_settings.py', and
77 override or add settings as necessary. You'll need to define the
85 You can generate the SECRET_KEY with the following python code:
88 chars = string.letters + string.digits + string.punctuation
89 print repr("".join([random.choice(chars) for i in range(0,50)]))
91 If you have patchwork installed in somewhere other than /srv/patchwork,
92 you'll also need to define:
97 If you wish to enable the XML-RPC interface, add the following to
98 your local_settings.py file:
102 Then, get patchwork to create its tables in your configured database:
105 PYTHONPATH=../lib/python ./manage.py syncdb
107 And add privileges for your mail and web users:
110 psql -f lib/sql/grant-all.postgres.sql patchwork
113 mysql patchwork < lib/sql/grant-all.mysql.sql
118 Example apache configuration files are in lib/apache/.
122 This should be the simpler of the two to set up. An example apache
123 configuration file is in:
125 lib/apache/patchwork.mod_python.conf
127 However, mod_python and mod_php may not work well together. So, if your
128 web server is used for serving php files, the fastcgi method may suit
133 django has built-in support for fastcgi, which requires the
134 'flup' python module. An example configuration is in:
136 lib/apache/patchwork.fastcgi.conf
138 - this also requires the mod_rewrite apache module to be loaded.
140 Once you have apache set up, you can start the fastcgi server with:
142 cd /srv/patchwork/apps
143 ./manage.py runfcgi method=prefork \
144 socket=/srv/patchwork/var/fcgi.sock \
145 pidfile=/srv/patchwork/var/fcgi.pid
147 4. Configure patchwork
148 Now, you should be able to administer patchwork, by visiting the
151 http://your-host/admin/
153 You'll probably want to do the following:
155 * Set up your projects
156 * Configure your website address (in the Sites) section of the admin
158 5. Subscribe a local address to the mailing list
160 You will need an email address for patchwork to receive email on - for
161 example - patchwork@, and this address will need to be subscribed to the
162 list. Depending on the mailing list, you will probably need to confirm the
163 subscription - temporarily direct the alias to yourself to do this.
165 6. Setup your MTA to deliver mail to the parsemail script
167 Your MTA will need to deliver mail to the parsemail script in the email/
168 directory. (Note, do not use the parsemail.py script directly). Something
169 like this in /etc/aliases is suitable for postfix:
171 patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
173 You may need to customise the parsemail.sh script if you haven't installed
174 patchwork in /srv/patchwork.
176 Test that you can deliver a patch to this script:
178 sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
183 * __init__() got an unexpected keyword argument 'max_length'
185 - you're running an old version of django. If your distribution doesn't
186 provide a newer version, just download and extract django into
189 * ERROR: permission denied for relation patchwork_...
191 - the user that patchwork is running as (ie, the user of the web-server)
192 doesn't have access to the patchwork tables in the database. Check that
193 your web-server user exists in the database, and that it has permissions