[Debian-l10n-commits] r2760 - /pootle/trunk/debian/README.Debian

Wed Nov 16 16:07:36 UTC 2011

Author: themill-guest
Date: Wed Nov 16 16:07:35 2011
New Revision: 2760

URL: http://svn.debian.org/wsvn/?sc=1&rev=2760
Log:
Update README.Debian for newer pootle

Modified:
    pootle/trunk/debian/README.Debian

Modified: pootle/trunk/debian/README.Debian
URL: http://svn.debian.org/wsvn/pootle/trunk/debian/README.Debian?rev=2760&op=diff
==============================================================================

--- pootle/trunk/debian/README.Debian (original)
+++ pootle/trunk/debian/README.Debian Wed Nov 16 16:07:35 2011
@@ -1,41 +1,85 @@
-Setting up of a Pootle server:
-==============================
+Pootle server quick start:
+==========================
 
-The Pootle server use the django framework. You can configure it using
-	django-admin --settings pootle
+1.  Create an adminstrative user
 
-You should setup 
-  * /etc/pootle/localsettings.py
-This file must be readable by the 'pootle' user.
-This file may contain passwords. In that case, you should restrict the
-access to this file, but note however that it should be readable by the
+The server will initially have a single user, 'admin'. This user's password may
+be set by using the 'changepassword' action for the django-admin command:
+
+    django-admin changepassword --settings=pootle.settings admin
+
+2.  Customise installation
+
+To send emails through the contact form and to improve performance, a number
+of settings need tweaking in /etc/pootle/localsettings.py. In particular:
+
+  * set DEFAULT_FROM_EMAIL so that users will be able to register
+  * set CONTACT_EMAIL so that the contact form works
+  * set CACHE_BACKEND based on your choice of database and the size of your
+    installation. Small installations can leave CACHE_BACKEND unset to use the
+    local memory backend, but if you have many projects/users/translations
+    the memcached backend may be preferred.
+  * set SESSION_ENGINE if you are using memcached.
+
+This file may contain passwords, in which case you should restrict the
+access to this file; however, note that it should be readable by the
 'pootle' user.
 
- * You must configure the mail address used to send the registrations code
-   of the new users. This address can be configured in the pootle.prefs
-   file (fromaddress).
+3.  Allow server to start
 
- * The Pootle server will be run at startup if you set the POOTLE_ENABLE
-   variable to "Yes" in /etc/default/pootle.
+The server will not run automatically unless you set POOTLE_ENABLE in
+'/etc/default/pootle' to 'Yes'.
+
+4.  Start the pootle server:
+
+    invoke-rc.d pootle restart
+
+5.  Log in and configure
+
+Log in through the web interface which runs by default on
+
+    http://localhost:8080/
+
+The "Admin" pages allow customisation of welcome messages, creation of
+additional users etc.
 
 
-#Once started, you need to create a Pootle admin:
-# 1 - register to your pootle server (it should be available at
-#     http://localhost:8080/)
-# 2 - use the registration code that you should receive by mail
-# 3 - edit the /etc/pootle/users.prefs file, and add
-#     "rights.siteadmin = True" to this user entry (you must respect the
-#     indentation).
-#
-#Only this Pootle admin will be able to add new projects and languages, or
-#to configure the rights of the other users.
+Further information
+===================
+
+The Pootle server uses the django framework. You can configure it using
+
+    django-admin <command> --settings=pootle.settings <options>
+
+where <command> and <options> are from the django-admin manual page or
+
+    http://translate.sourceforge.net/wiki/pootle/commands
+
+Additional information such as running the pootle server behind an SSL proxy
+or through the Apache web server's WSGI module (from the libapache2-mod-wsgi
+package) can be found on the pootle website at:
+
+    http://translate.sourceforge.net/wiki/pootle/optimisation
 
 
-#Security
-#========
-#Pootle implements an HTTP server. The users' passwords and translation are
-#transfered without any protection.
-#In order to secure the connexions to Pootle, you should use a SSL proxy.
-#
-#You can find an example of how to configure an apache proxy on:
-#http://translate.sourceforge.net/wiki/pootle/apache
+
+Recommended and Suggested Packages
+==================================
+
+python-xapian
+  indexing of translations to allow fast searching
+
+zip
+  upload and download of multiple po files
+
+python-levenshtein
+  similarity of strings for terminology matching
+
+iso-codes
+  ???
+
+python-aeidon
+  allow translations of video subtitles
+
+libapache2-mod-wsgi | httpd | cherrypy
+  improve performance of the pootle server


