Use config file for pwclient settings

[patchwork] / docs / INSTALL

diff --git a/docs/INSTALL b/docs/INSTALL
index 0d5cc3e78553510a10658ea1a060e139edb85e5b..cba69d55d664d532a13245224d8cba1ab824f25e 100644 (file)
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -62,15 +62,28 @@ in brackets):
          cd ../../apps
          ln -s ../lib/packages/django-registration ./registration
 
-       You'll need to customise apps/settings.py to suit your database, and
-       change the SECRET_KEY variable too. While you're there, change the
-       following to suit your installation:
+       (OPTIONAL) If you want to enable the Patchwork XML-RPC interface,
+        which is required for pwclient to work, you'll need to set up the
+        django_xmlrpc package:
 
-          SECRET_KEY
+         cd lib/packages/
+         wget \
+             http://django-xmlrpc.googlecode.com/files/django_xmlrpc-0.1.tar.gz
+         tar -zxf django_xmlrpc-0.1.tar.gz
+         cd ../../apps
+         ln -s ../lib/packages/django_xmlrpc ./django_xmlrpc
+
+       The settings.py file contains default settings for patchwork, you'll
+       need to configure settings for your own setup.
+
+       Rather than edit settings.py, create a file 'local_settings.py', and
+       override or add settings as necessary. You'll need to define the
+       following:
+
+         SECRET_KEY
          ADMINS
          TIME_ZONE
          LANGUAGE_CODE
-         MEDIA_ROOT
 
         You can generate the SECRET_KEY with the following python code:
 
@@ -78,10 +91,21 @@ in brackets):
           chars = string.letters + string.digits + string.punctuation
           print repr("".join([random.choice(chars) for i in range(0,50)]))
 
+       If you have patchwork installed in somewhere other than /srv/patchwork,
+       you'll also need to define:
+
+         MEDIA_ROOT
+         TEMPLATE_DIRS
+
+        If you wish to enable the XML-RPC interface, add the following to
+        your local_settings.py file:
+
+         ENABLE_XMLRPC = True
+
        Then, get patchwork to create its tables in your configured database:
 
         cd apps/
-        ./manage.py syncdb
+        PYTHONPATH=../lib/python ./manage.py syncdb
 
        And add privileges for your mail and web users: