annotate docs/admin/requirements.rst @ 2770:264e4015212e

docs: fixes, additions, formatting
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Tue, 02 Sep 2014 16:22:47 +0200
parents 42d4f773ca4a
children
rev   line source
0
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
1 ============
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
2 Requirements
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
3 ============
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
4
2314
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
5 MoinMoin requires Python 2.7.x. A CPython distribution is
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
6 recommended because it will likely be the fastest and most stable.
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
7 Most developers use a CPython distribution for testing.
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
8 Typical linux distributions will either have Python 2.7 installed by
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
9 default or will have a package manager that will install Python 2.7
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
10 as a secondary Python.
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
11 Windows users may download CPython distributions from http://www.python.org/ or
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
12 http://www.activestate.com/.
0
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
13
2314
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
14 An alternative implementation of Python, PyPy, is available
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
15 from http://pypy.org/.
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
16
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
17 The `virtualenv` Python package is also required. The
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
18 installation process for `virtualenv` varies with your OS and
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
19 Python distribution.
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
20 Many linux distributions have a package manager that may do
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
21 the installation. Windows users (and perhaps others) may download
2770
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2314
diff changeset
22 setuptools from https://pypi.python.org/pypi/setuptools.
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2314
diff changeset
23 Once setuptools is installed, do "`easy_install virtualenv`".
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2314
diff changeset
24 Current ActiveState distributions include virtualenv in the installation bundle.
2314
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
25 If all else fails, try Google.
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
26
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
27 Mercurial (hg) is required should you wish to contribute
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
28 patches to the moin2 development effort. Even if you do not
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
29 intend to contribute, Mercurial is highly recommended as it
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
30 will make it easy for you to obtain fixes and enhancements
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
31 from the moin2 repositories. Mercurial can be installed
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
32 with most linux package managers or downloaded
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
33 from http://mercurial.selenic.com/. As an alternative,
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
34 most Windows users will prefer to install TortoiseHG
2770
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2314
diff changeset
35 (includes Mercurial) from http://tortoisehg.bitbucket.org/.
2314
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
36
0
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
37
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
38 Servers
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
39 =======
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
40
2314
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
41 For moin2, you can use any server compatible with WSGI:
0
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
42
1150
63ae5723ce2c docs: proofread backup, index, install, requirements, serve, upgrade, thanks to jordonwii
Reimar Bauer <rb.proj AT googlemail DOT com>
parents: 449
diff changeset
43 * the builtin "moin" server is recommended for desktop wikis, testing,
63ae5723ce2c docs: proofread backup, index, install, requirements, serve, upgrade, thanks to jordonwii
Reimar Bauer <rb.proj AT googlemail DOT com>
parents: 449
diff changeset
44 debugging, development, adhoc-wikis, etc.
63ae5723ce2c docs: proofread backup, index, install, requirements, serve, upgrade, thanks to jordonwii
Reimar Bauer <rb.proj AT googlemail DOT com>
parents: 449
diff changeset
45 * apache with mod_wsgi is recommended for bigger/busier wikis.
63ae5723ce2c docs: proofread backup, index, install, requirements, serve, upgrade, thanks to jordonwii
Reimar Bauer <rb.proj AT googlemail DOT com>
parents: 449
diff changeset
46 * other WSGI-compatible servers or middlewares are usable
63ae5723ce2c docs: proofread backup, index, install, requirements, serve, upgrade, thanks to jordonwii
Reimar Bauer <rb.proj AT googlemail DOT com>
parents: 449
diff changeset
47 * For cgi, fastcgi, scgi, ajp, etc., you can use the "flup" middleware:
0
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
48 http://trac.saddi.com/flup
1150
63ae5723ce2c docs: proofread backup, index, install, requirements, serve, upgrade, thanks to jordonwii
Reimar Bauer <rb.proj AT googlemail DOT com>
parents: 449
diff changeset
49 * IIS with ISAPI-WSGI gateway is also compatible: http://code.google.com/p/isapi-wsgi/
0
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
50
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
51
286
f0288e2a7d09 update docs: now every dependency is installed via setup.py, no wget any more
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 212
diff changeset
52 Dependencies
f0288e2a7d09 update docs: now every dependency is installed via setup.py, no wget any more
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 212
diff changeset
53 ============
0
5568cf133caf create moin/2.0 repo, drop all history (see notes below)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents:
diff changeset
54
2770
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2314
diff changeset
55 Dependent packages will be automatically downloaded and installed during the
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2314
diff changeset
56 moin2 installation process. For a list of dependencies, see setup.py.
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2314
diff changeset
57
2029
47ed1aa1f741 add browser compatibility notes
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1402
diff changeset
58
47ed1aa1f741 add browser compatibility notes
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1402
diff changeset
59 Clients
47ed1aa1f741 add browser compatibility notes
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1402
diff changeset
60 =======
47ed1aa1f741 add browser compatibility notes
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1402
diff changeset
61 On the client side, you need:
47ed1aa1f741 add browser compatibility notes
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1402
diff changeset
62
2314
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
63 * a web browser that supports W3C standards HTML 5, CSS 2.1, and JavaScript:
2029
47ed1aa1f741 add browser compatibility notes
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1402
diff changeset
64
2314
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
65 - any current version of Firefox, Chrome, Opera, Safari, Maxthon, Internet Explorer (IE9 or newer).
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
66 - use of older Internet Explorer versions is not recommended and not supported.
2029
47ed1aa1f741 add browser compatibility notes
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1402
diff changeset
67
2314
42d4f773ca4a rewrite requirements.rst, install.rst, and development.rst to document make.py
RogerHaase <haaserd@gmail.com>
parents: 2109
diff changeset
68 * a Java browser plugin is required only if you want to use the TWikiDraw or AnyWikiDraw drawing applets.