q-doc/admin/requirements.rst
author weiher
Mon, 05 Feb 2018 16:54:45 +0100
changeset 12 d0f2a667d9d5
parent 0 bc83cf45066d
permissions -rw-r--r--
Mergen mit meinem Zweig
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     1
============
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     2
Requirements
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     3
============
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     4
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     5
MoinMoin requires Python 2.7.x. A CPython distribution is
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     6
recommended because it will likely be the fastest and most stable.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     7
Most developers use a CPython distribution for testing.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     8
Typical linux distributions will either have Python 2.7 installed by
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
     9
default or will have a package manager that will install Python 2.7
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    10
as a secondary Python.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    11
Windows users may download CPython distributions from  http://www.python.org/ or
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    12
http://www.activestate.com/.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    13
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    14
An alternative implementation of Python, PyPy, is available
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    15
from http://pypy.org/.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    16
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    17
The `virtualenv` Python package is also required. The
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    18
installation process for `virtualenv` varies with your OS and
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    19
Python distribution.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    20
Many linux distributions have a package manager that may do
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    21
the installation. Windows users (and perhaps others) may download
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    22
setuptools from https://pypi.python.org/pypi/setuptools.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    23
Once setuptools is installed, do "`easy_install virtualenv`".
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    24
Current ActiveState distributions include virtualenv in the installation bundle.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    25
If all else fails, try Google.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    26
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    27
Mercurial (hg) is required should you wish to contribute
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    28
patches to the moin2 development effort. Even if you do not
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    29
intend to contribute, Mercurial is highly recommended as it
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    30
will make it easy for you to obtain fixes and enhancements
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    31
from the moin2 repositories. Mercurial can be installed
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    32
with most linux package managers or downloaded
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    33
from http://mercurial.selenic.com/. As an alternative,
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    34
most Windows users will prefer to install TortoiseHG
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    35
(includes Mercurial) from http://tortoisehg.bitbucket.org/.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    36
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    37
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    38
Servers
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    39
=======
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    40
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    41
For moin2, you can use any server compatible with WSGI:
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    42
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    43
* the builtin "./m run" or "moin" server is recommended for desktop wikis, testing,
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    44
  debugging, development, adhoc-wikis, etc.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    45
* apache with mod_wsgi is recommended for bigger/busier wikis.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    46
* other WSGI-compatible servers or middlewares are usable
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    47
* For cgi, fastcgi, scgi, ajp, etc., you can use the "flup" middleware:
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    48
  http://trac.saddi.com/flup
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    49
* IIS with ISAPI-WSGI gateway is also compatible: http://code.google.com/p/isapi-wsgi/
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    50
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    51
.. caution:: When using the built-in server for public wikis (not recommended), use
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    52
        "./m run -d -r" to turn off the werkzeug debugger and auto reloader. See Werkzeug
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    53
        docs for more information.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    54
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    55
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    56
Dependencies
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    57
============
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    58
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    59
Dependent packages will be automatically downloaded and installed during the
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    60
moin2 installation process. For a list of dependencies, see setup.py.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    61
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    62
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    63
Clients
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    64
=======
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    65
On the client side, you need:
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    66
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    67
* a web browser that supports W3C standards HTML 5, CSS 2.1, and JavaScript:
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    68
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    69
  - any current version of Firefox, Chrome, Opera, Safari, Maxthon, Internet Explorer (IE9 or newer).
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    70
  - use of older Internet Explorer versions is not recommended and not supported.
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    71
bc83cf45066d Initial commit
Heinz Junkes <junkes@fhi-berlin.mpg.de>
parents:
diff changeset
    72
* a Java browser plugin is required only if you want to use the TWikiDraw or AnyWikiDraw drawing applets.