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)
20 At present, I've tested with PostgreSQL and (to a lesser extent) MySQL
21 database servers. If you have any (positive or negative) experiences with
24 For the following commands, a $ prefix signifies that the command should be
25 entered at your shell prompt, and a > prefix signifies the commant-line
26 client for your sql server (psql or mysql)
28 Create a database for the system, add accounts for two system users: the
29 web user (the user that your web server runs as) and the mail user (the
30 user that your mail server runs as). On Ubuntu these are
31 www-data and nobody, respectively.
33 As an alternative, you can use password-based login and a single database
34 account. This is described further down.
36 For PostgreSQL (ident-based)
42 - postgres uses the standard UNIX authentication, so these users
43 will only be accessible for processes running as the same username.
44 This means that no passwords need to be set.
46 For PostgreSQL (password-based)
48 $ createuser -PE patchwork
49 $ createdb -O patchwork patchwork
51 Once that is done, you need to tell Django about the new Database
52 settings, using local_settings.py (see below) to override the defaults
55 DATABASE_ENGINE = 'postgresql_psycopg2'
56 DATABASE_NAME = 'patchwork'
57 DATABASE_USER = 'patchwork'
58 DATABASE_PASSWORD = 'my_secret_password
59 DATABASE_HOST = 'localhost'
64 > CREATE DATABASE 'patchwork';
65 > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
66 > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
68 Once that is done, you need to tell Django about the new Database
69 settings, using local_settings.py (see below) to override the defaults
72 DATABASE_ENGINE = 'mysql'
73 DATABASE_NAME = 'patchwork'
74 DATABASE_USER = 'root'
75 DATABASE_PASSWORD = 'my_secret_root_password'
76 DATABSE_HOST = 'localhost'
81 Set up some initial directories in the patchwork base directory:
83 mkdir -p lib/packages lib/python
85 lib/packages is for stuff we'll download, lib/python is to add
86 to our python path. We'll symlink python modules into lib/python.
88 At the time of release, patchwork depends on django version 1.2 or
89 later. Your distro probably provides this. If not, do a:
92 git clone https://github.com/django/django.git -b stable/1.2.x
94 ln -s ../packages/django/django ./django
96 The settings.py file contains default settings for patchwork, you'll
97 need to configure settings for your own setup.
99 Rather than edit settings.py, create a file 'local_settings.py', and
100 override or add settings as necessary. You'll need to define the
108 NOTIFICATION_FROM_EMAIL
110 You can generate the SECRET_KEY with the following python code:
112 import string, random
113 chars = string.letters + string.digits + string.punctuation
114 print repr("".join([random.choice(chars) for i in range(0,50)]))
116 If you have patchwork installed in somewhere other than /srv/patchwork,
117 you'll also need to define:
122 If you wish to enable the XML-RPC interface, add the following to
123 your local_settings.py file:
127 Then, get patchwork to create its tables in your configured database:
130 PYTHONPATH=../lib/python/django ./manage.py syncdb
132 And add privileges for your mail and web users. This is only needed if
133 you use the ident-based approach. If you use password-based database
134 authentication, you can skip this step.
137 psql -f lib/sql/grant-all.postgres.sql patchwork
140 mysql patchwork < lib/sql/grant-all.mysql.sql
145 Example apache configuration files are in lib/apache2/.
148 django has built-in support for WSGI, which supersedes the fastcgi
149 handler. It is thus the preferred method to run patchwork.
151 The necessary configuration for Apache2 may be found in
153 lib/apache2/patchwork.wsgi.conf.
155 You will need to install/enable mod_wsgi for this to work:
162 An example apache configuration file for mod_python is in:
164 lib/apache2/patchwork.mod_python.conf
166 However, mod_python and mod_php may not work well together. So, if your
167 web server is used for serving php files, the fastcgi method may suit
172 django has built-in support for fastcgi, which requires the
173 'flup' python module. An example configuration is in:
175 lib/apache2/patchwork.fastcgi.conf
177 - this also requires the mod_rewrite apache module to be loaded.
179 Once you have apache set up, you can start the fastcgi server with:
181 cd /srv/patchwork/apps
182 ./manage.py runfcgi method=prefork \
183 socket=/srv/patchwork/var/fcgi.sock \
184 pidfile=/srv/patchwork/var/fcgi.pid
186 4. Configure patchwork
187 Now, you should be able to administer patchwork, by visiting the
190 http://your-host/admin/
192 You'll probably want to do the following:
194 * Set up your projects
195 * Configure your website address (in the Sites) section of the admin
197 5. Subscribe a local address to the mailing list
199 You will need an email address for patchwork to receive email on - for
200 example - patchwork@, and this address will need to be subscribed to the
201 list. Depending on the mailing list, you will probably need to confirm the
202 subscription - temporarily direct the alias to yourself to do this.
204 6. Setup your MTA to deliver mail to the parsemail script
206 Your MTA will need to deliver mail to the parsemail script in the email/
207 directory. (Note, do not use the parsemail.py script directly). Something
208 like this in /etc/aliases is suitable for postfix:
210 patchwork: "|/srv/patchwork/apps/patchwork/bin/parsemail.sh"
212 You may need to customise the parsemail.sh script if you haven't installed
213 patchwork in /srv/patchwork.
215 Test that you can deliver a patch to this script:
217 sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
222 * __init__() got an unexpected keyword argument 'max_length'
224 - you're running an old version of django. If your distribution doesn't
225 provide a newer version, just download and extract django into
228 * ERROR: permission denied for relation patchwork_...
230 - the user that patchwork is running as (ie, the user of the web-server)
231 doesn't have access to the patchwork tables in the database. Check that
232 your web-server user exists in the database, and that it has permissions
235 * pwclient fails for actions that require authentication, but a username
236 and password is given int ~/.pwclient rc. Server reports "No authentication
239 - if you're using the FastCGI interface to apache, you'll need the
240 '-pass-header Authorization' option to the FastCGIExternalServer
241 configuration directive.