pootle/contribs8/README.fedora

Pootle on Fedora
================

Welcome to Pootle running on Fedora.  This README offers some Fedora
specific information on Pootle.

0. Installation setup

- Database
You can use sqlite (default) or MySQL.  Sqlite requires no setup.
If you want to use MySQL then see section 3. below.

- Email
You need email for user registration confirmations, edit EMAIL_*
and DEFAULT_FROM_EMAIL in /etc/pootle/localsettings.py


1. Running Pootle

Regardless of how you choose to run Pootle (see below) the first run
will be slow.  This is because the Django database is initialised
and the files statistics are generated.  This is a once off event with
subsequent operations being much faster.

To run Pootle you can use Apache or run Pootle standalone:

- Apache (recommended)
Before running ensure that apache and memcached are running
$ services httpd start
$ services memcached start
Now point your web browser to http://localhost/pootle and Pootle
will run.

- Standalone (not recommended)
Before running ensure that memcached is running
$ services memcached start
Run PootleServer and Pootle will be available on http://localhost:8080

While you can run either of these ways it is recommended that you 
don't mix and match as you can get problems with file permission. Rather
stick to one approach.


2. Post installation

Your administrative user is username: admin, password: admin.  Make sure
that you change that before going live.


3. Optimising Pootle

To make Pootle go faster, especially on larger installations you will want
to do the following:

- Review optimisation hints
Pootle provides admins with various tips for optimisation, check that
your setup is running optimally by visiting:
http://localhost/pootle/admin/

- MySQL database
Pootle will by default use a sqlite database.  If you move to MySQL (or another
RDBMS) you should see improved performance.  Follow the setup instructions
at http://translate.sourceforge.net/wiki/pootle/using_mysql


4. Further information

4.1 Pootle and Version Control

The wiki has a lot of information on setting up the version control system
http://translate.sourceforge.net/wiki/pootle/version_control


4.2 Pootle and Translation Memory (TM)

The updatetm tool is what you want to use to supply translation memory 
suggestions to translators:
http://translate.sourceforge.net/wiki/pootle/updatetm


4.3 Terminology

You can setup a terminology project or terminology file to supply
terminology suggestions to translators:
http://translate.sourceforge.net/wiki/pootle/adding_a_terminology_project


4.4 Changes to Pootle on Fedora

The following changes have been made to a default Pootle setup

Optimisations:
- memcached - this is used by default for better performance
- apache - while Pootle can run standalone Apache provides better performance
  so we have made that standard.
- Xapian - for indexing searches otherwise they're quite slow
- Session stores - we store them in memcached for speed

Important files:
/etc/pootle/localsettings.py       - Pootle configuration file
/var/lib/pootle/dbs/stats.db       - your statistics cache
/var/lib/pootle/dbs/pootle.db      - your Django config, users, etc

Projects:
/var/lib/pootle/po/$project - your translation project files

-- 
Enjoy,
Pootle developers
1	slords	1.1	Pootle on Fedora
2			================
3
4			Welcome to Pootle running on Fedora. This README offers some Fedora
5			specific information on Pootle.
6
7			0. Installation setup
8
9			- Database
10			You can use sqlite (default) or MySQL. Sqlite requires no setup.
11			If you want to use MySQL then see section 3. below.
12
13			- Email
14			You need email for user registration confirmations, edit EMAIL_*
15			and DEFAULT_FROM_EMAIL in /etc/pootle/localsettings.py
16
17
18			1. Running Pootle
19
20			Regardless of how you choose to run Pootle (see below) the first run
21			will be slow. This is because the Django database is initialised
22			and the files statistics are generated. This is a once off event with
23			subsequent operations being much faster.
24
25			To run Pootle you can use Apache or run Pootle standalone:
26
27			- Apache (recommended)
28			Before running ensure that apache and memcached are running
29			$ services httpd start
30			$ services memcached start
31			Now point your web browser to http://localhost/pootle and Pootle
32			will run.
33
34			- Standalone (not recommended)
35			Before running ensure that memcached is running
36			$ services memcached start
37			Run PootleServer and Pootle will be available on http://localhost:8080
38
39			While you can run either of these ways it is recommended that you
40			don't mix and match as you can get problems with file permission. Rather
41			stick to one approach.
42
43
44			2. Post installation
45
46			Your administrative user is username: admin, password: admin. Make sure
47			that you change that before going live.
48
49
50			3. Optimising Pootle
51
52			To make Pootle go faster, especially on larger installations you will want
53			to do the following:
54
55			- Review optimisation hints
56			Pootle provides admins with various tips for optimisation, check that
57			your setup is running optimally by visiting:
58			http://localhost/pootle/admin/
59
60			- MySQL database
61			Pootle will by default use a sqlite database. If you move to MySQL (or another
62			RDBMS) you should see improved performance. Follow the setup instructions
63			at http://translate.sourceforge.net/wiki/pootle/using_mysql
64
65
66			4. Further information
67
68			4.1 Pootle and Version Control
69
70			The wiki has a lot of information on setting up the version control system
71			http://translate.sourceforge.net/wiki/pootle/version_control
72
73
74			4.2 Pootle and Translation Memory (TM)
75
76			The updatetm tool is what you want to use to supply translation memory
77			suggestions to translators:
78			http://translate.sourceforge.net/wiki/pootle/updatetm
79
80
81			4.3 Terminology
82
83			You can setup a terminology project or terminology file to supply
84			terminology suggestions to translators:
85			http://translate.sourceforge.net/wiki/pootle/adding_a_terminology_project
86
87
88			4.4 Changes to Pootle on Fedora
89
90			The following changes have been made to a default Pootle setup
91
92			Optimisations:
93			- memcached - this is used by default for better performance
94			- apache - while Pootle can run standalone Apache provides better performance
95			so we have made that standard.
96			- Xapian - for indexing searches otherwise they're quite slow
97			- Session stores - we store them in memcached for speed
98
99			Important files:
100			/etc/pootle/localsettings.py - Pootle configuration file
101			/var/lib/pootle/dbs/stats.db - your statistics cache
102			/var/lib/pootle/dbs/pootle.db - your Django config, users, etc
103
104			Projects:
105			/var/lib/pootle/po/$project - your translation project files
106
107			--
108			Enjoy,
109			Pootle developers