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