3 Patchwork uses the django framework - there is some background on deploying
4 django applications here:
6 http://www.djangobook.com/en/2.0/chapter12/
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, mysql)
16 * relevant python modules for the database server (e.g: python-mysqldb)
21 At present, I've tested with PostgreSQL and (to a lesser extent) MySQL
22 database servers. If you have any (positive or negative) experiences with
25 For the following commands, a $ prefix signifies that the command should be
26 entered at your shell prompt, and a > prefix signifies the command-line
27 client for your sql server (psql or mysql)
29 Create a database for the system, add accounts for two system users: the
30 web user (the user that your web server runs as) and the mail user (the
31 user that your mail server runs as). On Ubuntu these are
32 www-data and nobody, respectively.
34 As an alternative, you can use password-based login and a single database
35 account. This is described further down.
37 For PostgreSQL (ident-based)
43 - postgres uses the standard UNIX authentication, so these users
44 will only be accessible for processes running as the same username.
45 This means that no passwords need to be set.
47 For PostgreSQL (password-based)
49 $ createuser -PE patchwork
50 $ createdb -O patchwork patchwork
52 Once that is done, you need to tell Django about the new Database
53 settings, using local_settings.py (see below) to override the defaults
58 'ENGINE': 'django.db.backends.postgresql_psycopg2',
62 'PASSWORD': 'my_secret_password',
69 > CREATE DATABASE patchwork CHARACTER SET utf8;
70 > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
71 > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
73 Once that is done, you need to tell Django about the new Database
74 settings, using local_settings.py (see below) to override the defaults
79 'ENGINE': 'django.db.backends.mysql',
83 'PASSWORD': 'my_secret_password',
85 'TEST_CHARSET': 'utf8',
89 TEST_CHARSET is used when creating tables for the test suite. Without
90 it, tests checking for the correct handling of non-ASCII characters
96 Set up some initial directories in the patchwork base directory:
98 mkdir -p lib/packages lib/python
100 lib/packages is for stuff we'll download; lib/python is to add
101 to our python path. We'll symlink python modules into lib/python.
103 At the time of release, patchwork depends on django version 1.5 or
104 later. Your distro probably provides this. If not, do a:
107 git clone https://github.com/django/django.git -b stable/1.5.x
109 ln -s ../packages/django/django ./django
111 The settings.py file contains default settings for patchwork, you'll
112 need to configure settings for your own setup.
114 Rather than edit settings.py, create a file 'local_settings.py', and
115 override or add settings as necessary. You'll need to define the
123 NOTIFICATION_FROM_EMAIL
125 You can generate the SECRET_KEY with the following python code:
127 import string, random
128 chars = string.letters + string.digits + string.punctuation
129 print repr("".join([random.choice(chars) for i in range(0,50)]))
131 If you wish to enable the XML-RPC interface, add the following to
132 your local_settings.py file:
136 Then, get patchwork to create its tables in your configured database:
139 PYTHONPATH=../lib/python ./manage.py syncdb
141 And add privileges for your mail and web users. This is only needed if
142 you use the ident-based approach. If you use password-based database
143 authentication, you can skip this step.
146 psql -f lib/sql/grant-all.postgres.sql patchwork
149 mysql patchwork < lib/sql/grant-all.mysql.sql
154 Example apache configuration files are in lib/apache2/.
158 django has built-in support for WSGI, which supersedes the fastcgi
159 handler. It is thus the preferred method to run patchwork.
161 The necessary configuration for Apache2 may be found in
163 lib/apache2/patchwork.wsgi.conf.
165 You will need to install/enable mod_wsgi for this to work:
173 An example apache configuration file for mod_python is in:
175 lib/apache2/patchwork.mod_python.conf
177 However, mod_python and mod_php may not work well together. So, if your
178 web server is used for serving php files, the fastcgi method may suit
184 django has built-in support for fastcgi, which requires the
185 'flup' python module. An example configuration is in:
187 lib/apache2/patchwork.fastcgi.conf
189 - this also requires the mod_rewrite apache module to be loaded.
191 Once you have apache set up, you can start the fastcgi server with:
193 cd /srv/patchwork/apps
194 ./manage.py runfcgi method=prefork \
195 socket=/srv/patchwork/var/fcgi.sock \
196 pidfile=/srv/patchwork/var/fcgi.pid
199 4. Configure patchwork
200 Now, you should be able to administer patchwork, by visiting the
203 http://your-host/admin/
205 You'll probably want to do the following:
207 * Set up your projects
208 * Configure your website address (in the Sites) section
211 5. Subscribe a local address to the mailing list
213 You will need an email address for patchwork to receive email on - for
214 example - patchwork@, and this address will need to be subscribed to the
215 list. Depending on the mailing list, you will probably need to confirm the
216 subscription - temporarily direct the alias to yourself to do this.
219 6. Setup your MTA to deliver mail to the parsemail script
221 Your MTA will need to deliver mail to the parsemail script in the email/
222 directory. (Note, do not use the parsemail.py script directly). Something
223 like this in /etc/aliases is suitable for postfix:
225 patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
227 You may need to customise the parsemail.sh script if you haven't installed
228 patchwork in /srv/patchwork.
230 Test that you can deliver a patch to this script:
232 sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
235 7. Set up the patchwork cron script
237 Patchwork uses a cron script to clean up expired registrations, and
238 send notifications of patch changes (for projects with this enabled).
240 Something like this in your crontab should work:
242 # m h dom mon dow command
244 DJANGO_SETTINGS_MODULE=settings
245 */10 * * * * cd patchwork; python apps/patchwork/bin/patchwork-cron.py
248 - the frequency should be the same as the NOTIFICATION_DELAY_MINUTES
249 setting, which defaults to 10 minutes.
252 8. Optional: Configure your VCS to automatically update patches
254 The tools directory of the patchwork distribution contains a file
255 named post-receive.hook which is an example git hook that can be
256 used to automatically update patches to the Accepted state when
257 corresponding comits are pushed via git.
259 To install this hook, simply copy it to the .git/hooks directory on
260 your server, name it post-receive, and make it executable.
262 This sample hook has support to update patches to different states
263 depending on which branch is being pushed to. See the STATE_MAP
264 setting in that file.
266 If you are using a system other than git, you can likely write a
267 similar hook using pwclient to update patch state. If you do write
268 one, please contribute it.
273 * __init__() got an unexpected keyword argument 'max_length'
275 - you're running an old version of django. If your distribution doesn't
276 provide a newer version, just download and extract django into
279 * ERROR: permission denied for relation patchwork_...
281 - the user that patchwork is running as (ie, the user of the web-server)
282 doesn't have access to the patchwork tables in the database. Check that
283 your web-server user exists in the database, and that it has permissions
286 * pwclient fails for actions that require authentication, but a username
287 and password is given in ~/.pwclientrc. Server reports "No authentication
290 - if you're using the FastCGI interface to apache, you'll need the
291 '-pass-header Authorization' option to the FastCGIExternalServer
292 configuration directive.