← Back to branch summary

~ubuntu-branches/ubuntu/natty/moin/natty-updates

« back to all changes in this revision

Viewing changes to docs/REQUIREMENTS

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Smedegaard
  • Date: 2008-06-22 21:17:13 UTC
  • mto: This revision was merged to the branch mainline in revision 18.
  • Revision ID: james.westby@ubuntu.com-20080622211713-inlv5k4eifxckelr
Import upstream version 1.7.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/REQUIREMENTS
1
 
Python requirements
2
 
===================
3
 
 
4
 
Please use Python 2.4.x, 2.5.x or 2.6.x, we recommend 2.5.x / 2.6.x.
5
 
 
6
 
Python 2.3 is not supported by moin 1.9.x (use moin 1.8.x if you can't
7
 
upgrade Python).
8
 
 
9
 
Python 3.x won't work for MoinMoin for now.
10
 
 
11
 
Python build options:
12
 
 * zlib support (required)
13
 
 * ucs4 (32bit unicode, recommended)
14
 
 * ucs2 also works for most users (not recommended)
15
 
 
16
 
 
17
 
Servers
18
 
=======
19
 
You can use anything that speaks WSGI to moin:
20
 
 * the "standalone" wikiserver.py we bundle with moin (recommended for
21
 
   desktop wikis, testing, debugging, development, adhoc-wikis)
22
 
 * apache with mod_wsgi (recommended for bigger/busier wikis), do not use
23
 
   mod_wsgi v2.3 (it has known problems), about any other version is fine.
24
 
 * other WSGI-compatible servers
25
 
 * cgi, fastcgi, scgi, ajp, ... also work via the "flup" middleware bundled with moin
26
 
 * For IIS 6.0 on Windows 2003, you can use a ISAPI-WSGI gateway:
27
 
   http://code.google.com/p/isapi-wsgi/ v0.4.1 has been used successfully.
28
 
 
29
 
 
30
 
Requirements needed for some moin features
31
 
==========================================
32
 
 
33
 
RSS feed: python-xml (pyxml) or python >= 2.5.1
34
 
 
35
 
GUI editor: python-xml (pyxml) - more precisely, this stuff is needed by the
36
 
            html to wiki markup converter invoked when the gui editor posts
37
 
            html on save. Status for python 2.5.x unknown.
38
 
 
39
 
Docbook formatter: python-xml (pyxml).
40
 
 
41
 
docbook parser: 4suite 1.0a4 or 1.0b1
42
 
 
43
 
xslt parser: 4suite 1.0a4 or 1.0b1
44
 
 
45
 
rst parser: docutils >= 0.3.10
46
 
 
47
 
Xapian indexed search: xapian libs + python bindings >= 1.0.6
48
 
 
49
 
Indexing filters for xapian search:
50
 
 * antiword (for indexing of MS Word documents)
51
 
 * xls2csv (for indexing of MS Excel documents, from catdoc package)
52
 
 * catppt (for indexing of MS Powerpoint documents, from catdoc package)
53
 
 * catdoc (for indexing of RTF documents, from catdoc package)
54
 
 * pdftotext (for indexing of PDFs, from xpdf-utils or poppler-utils)
55
 
 
56
 
ldap_login auth: python-ldap >=2.0.0pre06
57
 
 
58
 
mysql_group auth: MySQLdb python module
59
 
 
60
 
openidrp auth: openid python module
61
 
 
62
 
stats charts: gdchart python module
63
 
 
64
 
jabberbot: pyxmpp SVN revision 665 or release >= 1.0.1
65
 
 
66
 
 
67
 
Bundled 3rd party code
68
 
======================
69
 
 
70
 
Below are some notes about the software we bundle and ship with MoinMoin.
71
 
If you are a Linux distributor and you want to rip out this stuff and
72
 
replace it with packages, this is for you!
73
 
 
74
 
We list the shipped version and also the minimum required version.
75
 
The shipped version will work best with moin as usually has some more bug
76
 
fixes than the minimum required version.
77
 
We do not test with the minimum required version, but we try to keep this
78
 
file updated and correct to our best knowledge.
79
 
 
80
 
In case you find bugs in this requirements specification, please let us know!
81
 
 
82
 
Thanks to all 3rd party software authors!
83
 
 
84
 
 
85
 
A) Stuff below MoinMoin/support/:
86
 
 
87
 
flup (cgi/fastcgi/scgi/ajp to WSGI adapter)
88
 
===========================================
89
 
shipped: 1.0.2+, from repo: hg clone -r 72496e17674f http://hg.saddi.com/flup-server
90
 
minimum: 1.0.2
91
 
 
92
 
 
93
 
pygments (highlighting for all sorts of source code and other text files)
94
 
=========================================================================
95
 
shipped: 1.3.1
96
 
minimum: 1.1.1 will work, maybe even older versions
97
 
 
98
 
 
99
 
parsedatetime (parse date/time strings)
100
 
=======================================
101
 
shipped: 0.8.7
102
 
minimum: 0.8.7(?)
103
 
 
104
 
 
105
 
werkzeug (WSGI toolkit)
106
 
=======================
107
 
shipped: 0.5.1
108
 
minimum: 0.5.1 will work, maybe 0.5 and 0.6.x also
109
 
 
110
 
 
111
 
xappy (High-Level Python library for Xapian)
112
 
============================================
113
 
shipped: 0.5
114
 
minimum: 0.5
115
 
 
116
 
 
117
 
htmlmarkup.py (safe html rendering)
118
 
===================================
119
 
shipped: copied from TRAC's trac.util.html, revision 3609, merged on 2006-08-20
120
 
minimum: same(?)
121
 
 
122
 
 
123
 
Replacements for Python stdlib modules
124
 
======================================
125
 
difflib.py (fixes broken Python 2.4.3 difflib, see comment in file)
126
 
HeaderFixed.py ("copied from email.Header because the original is broken")
127
 
tarfile.py (misc. brokenness up to Python 2.6, see comment in file)
128
 
 
129
 
 
130
 
Other stuff
131
 
===========
132
 
BasicAuthTransport.py (taken from Amos' XML-RPC HowTo)
133
 
python_compatibility.py (to be compatible with older Pythons)
134
 
 
135
 
 
136
 
B) MoinMoin/web/static/htdocs/applets/FCKEditor/
137
 
shipped: 2.6.6
138
 
required: 2.6.x
139
 
 
140
 
 
141
 
C) MoinMoin/web/static/htdocs/applets/TWikiDrawPlugin/
142
 
shipped: Using a modified TWikiDrawPlugin see README in contrib/TWikiDrawPlugin 
143
 
required: see shipped
144
 
 
145
 
 
146
 
D) MoinMoin/web/static/htdocs/applets/anywikidraw/
147
 
shipped: 0.14
148
 
required: 0.14
149