]> git.ozlabs.org Git - patchwork/blobdiff - docs/INSTALL
[parser] Fix spacing for encoded headers
[patchwork] / docs / INSTALL
index da8dd54f71314d6489c4667e5eabfa632c2b651c..8f3aab93f6fe48a57b69b482734ac74f35c81882 100644 (file)
@@ -42,19 +42,59 @@ in brackets):
 
 2. Django setup
 
-       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:
-
-         ADMINS,
+        At the time of initial release, patchwork depends on a svn version of
+        django. I've been using svn commit 7854 - but anything after this
+        point should be fine. If your distribution provides a sufficiently
+        recent version of django, you can use that; if not, do a:
+
+         cd lib/packages
+         svn checkout http://code.djangoproject.com/svn/django/trunk django
+         cd ../python
+         ln -s ../packages/django/django ./django
+
+        We also use the django-registration infrastructure from
+        http://code.google.com/p/django-registration/
+
+         cd lib/packages/
+         svn checkout \
+             http://django-registration.googlecode.com/svn/trunk/registration/ \
+             django-registration
+         cd ../../apps
+         ln -s ../lib/packages/django-registration ./registration
+
+       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
+
+        You can generate the SECRET_KEY with the following python code:
+
+          import string, random
+          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:
 
@@ -62,6 +102,7 @@ in brackets):
          psql -f lib/sql/grant-all.sql patchwork
 
 
+
 3. Apache setup
 
 Example apache configuration files are in lib/apache/.
@@ -102,7 +143,7 @@ fastcgi:
     You'll probably want to do the following:
 
       * Set up your projects
-
+      * Configure your website address (in the Sites) section of the admin
 
 5. Subscribe a local address to the mailing list