docs: Add a pointer to the git post-receive hook

[patchwork] / docs / INSTALL

diff --git a/docs/INSTALL b/docs/INSTALL
index ee87e4d5d58837c87a525f6b1e922ce77a361996..2c1a0a95593ba4ed2fb27454557f92d9d3e3b151 100644 (file)
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -9,10 +9,11 @@ You'll need the following (applications used for patchwork development are
 in brackets):
 
   * A python interpreter
-  * django >= 1.2
+  * django >= 1.5
   * A webserver (apache)
   * mod_python or flup
-  * A database server (postgresql)
+  * A database server (postgresql, mysql)
+  * relevant python modules for the database server (e.g: python-mysqldb)
 
 1. Database setup
 
@@ -64,6 +65,17 @@ in brackets):
         > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
         > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
 
+       Once that is done, you need to tell Django about the new Database
+       settings, using local_settings.py (see below) to override the defaults
+       in settings.py:
+
+       DATABASE_ENGINE = 'mysql'
+       DATABASE_NAME = 'patchwork'
+       DATABASE_USER = 'root'
+       DATABASE_PASSWORD = 'my_secret_root_password'
+       DATABSE_HOST = 'localhost'
+       DATABASE_PORT = ''
+
 2. Django setup
 
         Set up some initial directories in the patchwork base directory:
@@ -73,37 +85,14 @@ in brackets):
         lib/packages is for stuff we'll download, lib/python is to add
         to our python path. We'll symlink python modules into lib/python.
 
-        At the time of release, patchwork depends on django version 1.2 or
+        At the time of release, patchwork depends on django version 1.5 or
         later. Your distro probably provides this. If not, do a:
 
          cd lib/packages
-         svn checkout http://code.djangoproject.com/svn/django/tags/releases/1.2
+         git clone https://github.com/django/django.git -b stable/1.5.x
          cd ../python
          ln -s ../packages/django/django ./django
 
-        We also use the django-registration infrastructure from
-        http://bitbucket.org/ubernostrum/django-registration/. Your distro
-        may provide the django-registration python module (in Ubuntu/Debian it's
-        called 'python-django-registration'). If not, download the module
-        and symlink it to lib/python/ :
-
-         cd lib/packages/
-         hg clone http://bitbucket.org/ubernostrum/django-registration/
-         cd ../python
-         ln -s ../packages/django-registration/registration ./registration
-
-        We also use some Javascript libraries:
-
-         cd lib/packages
-         mkdir jquery
-         cd jquery
-         wget http://jqueryjs.googlecode.com/files/jquery-1.3.min.js
-         wget http://www.isocra.com/articles/jquery.tablednd_0_5.js.zip
-         unzip jquery.tablednd_0_5.js.zip jquery.tablednd_0_5.js
-         cd ../../../htdocs/js/
-         ln -s ../../lib/packages/jquery/jquery-1.3.min.js ./
-         ln -s ../../lib/packages/jquery/jquery.tablednd_0_5.js ./
-
         The settings.py file contains default settings for patchwork, you'll
         need to configure settings for your own setup.
 
@@ -115,6 +104,8 @@ in brackets):
           ADMINS
           TIME_ZONE
           LANGUAGE_CODE
+          DEFAULT_FROM_EMAIL
+          NOTIFICATION_FROM_EMAIL
 
         You can generate the SECRET_KEY with the following python code:
 
@@ -125,6 +116,7 @@ in brackets):
         If you have patchwork installed in somewhere other than /srv/patchwork,
         you'll also need to define:
 
+          ROOT_DIR
           MEDIA_ROOT
           TEMPLATE_DIRS
 
@@ -136,7 +128,7 @@ in brackets):
         Then, get patchwork to create its tables in your configured database:
 
          cd apps/
-         PYTHONPATH=../lib/python ./manage.py syncdb
+         PYTHONPATH=../lib/python/django ./manage.py syncdb
 
         And add privileges for your mail and web users. This is only needed if
         you use the ident-based approach. If you use password-based database
@@ -225,6 +217,23 @@ fastcgi:
 
      sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
 
+7. Optional: Configure your VCS to automatically update patches
+
+    The tools directory of the patchwork distribution contains a file
+    named post-receive.hook which is an example git hook that can be
+    used to automatically update patches to the Accepted state when
+    corresponding comits are pushed via git.
+
+    To install this hook, simply copy it to the .git/hooks directory on
+    your server, name it post-receive, and make it executable.
+
+    This sample hook has support to update patches to different states
+    depending on which branch is being pushed to. See the STATE_MAP
+    setting in that file.
+
+    If you are using a system other than git, you can likely write a
+    similar hook using pwclient to update patch state. If you do write
+    one, please contribute it.
 
 Some errors: