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:
138 PYTHONPATH=lib/python ./manage.py syncdb
140 And add privileges for your mail and web users. This is only needed if
141 you use the ident-based approach. If you use password-based database
142 authentication, you can skip this step.
145 psql -f lib/sql/grant-all.postgres.sql patchwork
148 mysql patchwork < lib/sql/grant-all.mysql.sql
153 Example apache configuration files are in lib/apache2/.
157 django has built-in support for WSGI, which supersedes the fastcgi
158 handler. It is thus the preferred method to run patchwork.
160 The necessary configuration for Apache2 may be found in
162 lib/apache2/patchwork.wsgi.conf.
164 You will need to install/enable mod_wsgi for this to work:
172 An example apache configuration file for mod_python is in:
174 lib/apache2/patchwork.mod_python.conf
176 However, mod_python and mod_php may not work well together. So, if your
177 web server is used for serving php files, the fastcgi method may suit
183 django has built-in support for fastcgi, which requires the
184 'flup' python module. An example configuration is in:
186 lib/apache2/patchwork.fastcgi.conf
188 - this also requires the mod_rewrite apache module to be loaded.
190 Once you have apache set up, you can start the fastcgi server with:
193 ./manage.py runfcgi method=prefork \
194 socket=/srv/patchwork/var/fcgi.sock \
195 pidfile=/srv/patchwork/var/fcgi.pid
198 4. Configure patchwork
199 Now, you should be able to administer patchwork, by visiting the
202 http://your-host/admin/
204 You'll probably want to do the following:
206 * Set up your projects
207 * Configure your website address (in the Sites) section
210 5. Subscribe a local address to the mailing list
212 You will need an email address for patchwork to receive email on - for
213 example - patchwork@, and this address will need to be subscribed to the
214 list. Depending on the mailing list, you will probably need to confirm the
215 subscription - temporarily direct the alias to yourself to do this.
218 6. Setup your MTA to deliver mail to the parsemail script
220 Your MTA will need to deliver mail to the parsemail script in the email/
221 directory. (Note, do not use the parsemail.py script directly). Something
222 like this in /etc/aliases is suitable for postfix:
224 patchwork: "|/srv/patchwork/patchwork/bin/parsemail.sh"
226 You may need to customise the parsemail.sh script if you haven't installed
227 patchwork in /srv/patchwork.
229 Test that you can deliver a patch to this script:
231 sudo -u nobody /srv/patchwork/patchwork/bin/parsemail.sh < mail
234 7. Set up the patchwork cron script
236 Patchwork uses a cron script to clean up expired registrations, and
237 send notifications of patch changes (for projects with this enabled).
239 Something like this in your crontab should work:
241 # m h dom mon dow command
243 DJANGO_SETTINGS_MODULE=settings
244 */10 * * * * cd patchwork; python patchwork/bin/patchwork-cron.py
247 - the frequency should be the same as the NOTIFICATION_DELAY_MINUTES
248 setting, which defaults to 10 minutes.
251 8. Optional: Configure your VCS to automatically update patches
253 The tools directory of the patchwork distribution contains a file
254 named post-receive.hook which is an example git hook that can be
255 used to automatically update patches to the Accepted state when
256 corresponding comits are pushed via git.
258 To install this hook, simply copy it to the .git/hooks directory on
259 your server, name it post-receive, and make it executable.
261 This sample hook has support to update patches to different states
262 depending on which branch is being pushed to. See the STATE_MAP
263 setting in that file.
265 If you are using a system other than git, you can likely write a
266 similar hook using pwclient to update patch state. If you do write
267 one, please contribute it.
272 * __init__() got an unexpected keyword argument 'max_length'
274 - you're running an old version of django. If your distribution doesn't
275 provide a newer version, just download and extract django into
278 * ERROR: permission denied for relation patchwork_...
280 - the user that patchwork is running as (ie, the user of the web-server)
281 doesn't have access to the patchwork tables in the database. Check that
282 your web-server user exists in the database, and that it has permissions
285 * pwclient fails for actions that require authentication, but a username
286 and password is given in ~/.pwclientrc. Server reports "No authentication
289 - if you're using the FastCGI interface to apache, you'll need the
290 '-pass-header Authorization' option to the FastCGIExternalServer
291 configuration directive.