← Back to branch summary

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

« back to all changes in this revision

Viewing changes to wiki/underlay/pages/HelpOnInstalling(2f)BasicInstallation/revisions/00000001

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Smedegaard
  • Date: 2008-06-22 21:17:13 UTC
  • mfrom: (0.9.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080622211713-fpo2zrq3s5dfecxg
Tags: 1.7.0-3
Simplify /etc/moin/wikilist format: "USER URL" (drop unneeded middle
CONFIG_DIR that was wrongly advertised as DATA_DIR).  Make
moin-mass-migrate handle both formats and warn about deprecation of
the old one.

Show diffs side-by-side

added added

removed removed

Lines of Context:
wiki/underlay/pages/HelpOnInstalling(2f)BasicInstallation/revisions/00000001
1
 
## Please edit system and help pages ONLY in the moinmaster wiki! For more
2
 
## information, please see MoinMaster:MoinPagesEditorGroup.
 
1
## Please edit system and help pages ONLY in the master wiki!
 
2
## For more information, please see MoinMoin:MoinDev/Translation.
3
3
##master-page:Unknown-Page
4
4
##master-date:Unknown-Date
5
 
#acl MoinPagesEditorGroup:read,write,delete,revert All:read
 
5
#acl -All:write Default
6
6
#format wiki
7
7
#language en
8
8
 
10
10
'''How to do a basic installation of MoinMoin on your system.'''
11
11
 
12
12
'''Contents'''
13
 
[[TableOfContents]]
 
13
<<TableOfContents>>
14
14
 
15
 
Before you can integrate Moin``Moin into your web environment, you have to install the MoinMoin source code and data files using the standard Python ''distutils'' mechanism (`setup.py`). This page explains the steps you usually need to take to do this. For more details on the ''distutils'' installation process, consult the [http://www.python.org/doc/current/inst/inst.html Installing Python Modules] document in your Python documentation set.
 
15
Before you can integrate Moin``Moin into your web environment, you have to install the MoinMoin source code and data files using the standard Python ''distutils'' mechanism (`setup.py`). This page explains the steps you usually need to take to do this. For more details on the ''distutils'' installation process, consult the [[http://www.python.org/doc/current/inst/inst.html|Installing Python Modules]] document in your Python documentation set.
16
16
 
17
17
The installation is similar on Windows and Linux (and other POSIX-type systems; for simplicity, we just say "Linux" in the docs).
18
18
 
22
22
 
23
23
Moin``Moin needs Python to run, so the first step is to check if an usable version of Python is installed and correctly set-up. If this is not the case, you will have to fix that before you can proceed.
24
24
 
25
 
The `CHANGES` file in the Moin``Moin archive mentions what versions are supported. Python 2.3 is the minimum requirement for Moin``Moin 1.5, but we suggest you use the latest Python release version.
 
25
The `CHANGES` file in the Moin``Moin archive mentions what versions are supported. Python 2.3 is the minimum requirement for Moin``Moin 1.7, but we suggest you use the latest Python release version.
26
26
 
27
 
You can download Python at [http://www.python.org/download/].
 
27
You can download Python at [[http://www.python.org/download/]].
28
28
 
29
29
If you are pretty sure an acceptable version of Python is installed but the commands below do not work, this may be because your Python files are not in the ''search path''. Correctly setting the search path is outside the scope of this document; please ask for help on your favorite Python, Linux, or Windows discussion board.
30
30
 
31
31
If you have shell access, checking if Python is working is very simple. Just type the following command, and look at the result:
32
32
{{{
33
33
> python -V
34
 
Python 2.3.4
 
34
Python 2.4.4
35
35
}}}
36
36
 
37
37
If you don't have shell access, you can try using this `pythontest.cgi` script (it assumes that you are using a Linux kind of webserver). Upload the script to your `cgi-bin` directory, use `chmod a+rx pythontest.cgi` (or a similar command in your FTP program) to make it executable, and invoke it using your web browser.
38
38
 
39
 
inline:pythontest.cgi
 
39
{{attachment:pythontest.cgi}}
40
40
 
41
41
If it doesn't display "CGI scripts work", well, then CGI scripts don't work. If it doesn't show one or more Python version numbers, then Python is not correctly installed. In both cases, before you can proceed, you will have to get in touch with the administrator of the server so that the problems get corrected.
42
42
 
44
44
 
45
45
= Download MoinMoin =
46
46
 
47
 
To download the distribution archive, go to the [http://sourceforge.net/project/showfiles.php?group_id=8482 download area] and fetch the latest archive.
 
47
To download the distribution archive, go to the [[http://moinmo.in/MoinMoinDownload|download page]] and fetch the latest archive.
48
48
 
49
49
The next step is to unpack the distribution archive (which you have done already if you are reading this text from your hard drive). If you read this on the web, the distribution comes in a versioned `.tar.gz` archive, which you can unpack as shown below.
50
50
 
51
51
 * On Windows
52
 
    * You can use recent versions of programs like Win``Zip, Win``Rar, and Win``Ace, which handle .tar.gz kind of archives.
53
 
    * At the command prompt, you can use [http://gnuwin32.sourceforge.net/packages/gzip.htm GNU gzip] and [http://gnuwin32.sourceforge.net/packages/tar.htm GNU tar] for Windows.
 
52
    * You can use recent versions of programs like [[http://www.7-zip.org/|7-Zip]], Win``Zip, Win``Rar, and Win``Ace, which handle .tar.gz kind of archives.
 
53
    * At the command prompt, you can use [[http://gnuwin32.sourceforge.net/packages/gzip.htm|GNU gzip]] and [[http://gnuwin32.sourceforge.net/packages/tar.htm|GNU tar]] for Windows.
54
54
 * On Linux
55
55
    * You can use your favorite file manager -- it should be able to unpack them.
56
56
    * At any shell prompt, you can use the `tar` command.
57
57
 
58
 
The distribution archive will always unpack into a directory named `moin-<version>`, for example `moin-1.5`.
 
58
The distribution archive will always unpack into a directory named `moin-<version>`, for example `moin-1.7.0`.
59
59
 
60
60
Here is how you would unpack the archive (using GNU tar) and enter the directory with the Moin``Moin files:
61
61
{{{
62
 
> tar xzf moin-1.5.0.tar.gz
63
 
> cd moin-1.5.0
 
62
> tar xzf moin-1.7.0.tar.gz
 
63
> cd moin-1.7.0
64
64
}}}
65
65
 
66
66
= Install MoinMoin =
73
73
 
74
74
/!\ If you have several versions of Python installed, please use the same version for setup and for running the wiki. Usually, the latest Python version will get the best results.
75
75
 
 
76
== Recommended installation command for Linux (and MacOs X) ==
 
77
As you have chosen to not use a preconfigured package for your system this time it is highly recommended that you do not install MoinMoin into the default location. This is because otherwise, if you later want to install a moin package of your distribution this will overwrite your existing installation. The most common path for your own installations is below {{{/usr/local}}} (this is called the PREFIX). A command that should be ok for most Linux distributions and also MacOS X is
 
78
 
 
79
{{{
 
80
> python setup.py install --prefix='/usr/local' --record=install.log
 
81
}}}
 
82
 
 
83
This will install the shared files to '/usr/local/share/moin' and the moin code to `/usr/local/lib/python2.x/site-packages/MoinMoin/`.
 
84
 
 
85
== Debugging setup process ==
 
86
 
76
87
If you have problems with the `setup.py` install step, try using the command:
77
88
{{{
78
89
> python -v setup.py --quiet install --record=install.log
80
91
 
81
92
The additional `-v` flag should provide you detailed verbose messages every step of the way.
82
93
 
83
 
/!\ On Linux, if u get an error like `Invalid Python installation: cannot find /usr/lib/Python2.x/config/Makefile`, you may not have the python module '''`distutils`''' installed, it's usually a part of the '''Python development libarary (`python-dev`)'''. Some Linux distributions may not have installed it by default. For example, on Mandrake you need to install the '''`python-devel`''' package, on Debian it's called '''`python-dev`'''.
 
94
/!\ On Linux, if you get an error like `Invalid Python installation: cannot find /usr/lib/Python2.x/config/Makefile`, you may not have the python module '''`distutils`''' installed, it's usually a part of the '''Python development libarary (`python-dev`)'''. Some Linux distributions may not have installed it by default. For example, on Mandrake you need to install the '''`python-devel`''' package, on Debian it's called '''`python-dev`'''.
84
95
 
85
 
== Installing in the default system location ==
 
96
== Installing to the default system location ==
86
97
 
87
98
{{{
88
99
> python setup.py --quiet install --record=install.log
89
100
}}}
90
101
 
91
 
This installs Moin``Moin to the default system location (typically the Python directory, for example on Linux, inside `/usr/lib` and `/usr/share`). Look at the `install.log` file to see what was installed, and where.
92
 
 
93
 
 * Mac OS X note: use the command:
94
 
 {{{
95
 
python setup.py install --install-data='/usr/local'
96
 
}}}
97
 
 This will install the shared files to '/usr/local/share/moin', instead of an inconvenient location in the System folder.
 
102
This installs Moin``Moin to the default system location (typically the Python directory, for example on Linux, inside `/usr/lib/python2.x/site-packages/MoinMoin` and `/usr/share/moin`). Look at the `install.log` file to see what was installed, and where.
 
103
 
 
104
 
98
105
 
99
106
== Installing in the home directory or another specific location ==
100
107
 
112
119
 
113
120
'''Note:''' You will likely see the following warning:
114
121
 
115
 
    `warning: install: modules installed to 'C:\moin\', which`[[BR]]
116
 
    `is not in Python's module search path (sys.path) -- you'll`[[BR]]
 
122
    `warning: install: modules installed to 'C:\moin\', which`<<BR>>
 
123
    `is not in Python's module search path (sys.path) -- you'll`<<BR>>
117
124
    `have to change the search path yourself`
118
125
 
119
126
This means exactly what it says, you need to add your install directory to the search path of Python, or it won't find the Moin``Moin code.
130
137
 
131
138
{{{
132
139
> python
133
 
Python 2.3.4 (#1, May 29 2004, 17:05:23)
134
 
[GCC 3.3.3] on linux2
 
140
Python 2.4.4 (...)
135
141
Type "help", "copyright", "credits" or "license" for more information.
136
142
>>> import MoinMoin
137
143
>>>
155
161
 
156
162
/!\ It is important that you understand the different locations used in a Moin``Moin setup, so read this carefully.
157
163
 
158
 
In the following descriptions, `PREFIX` is what you used with the `setup.py` command, or a default location if you didn't use the `--prefix` option. (Typical default values on Linux are `/usr` and `/usr/local`.) `X.Y` is the version of Python. Typically, this is `2.3` or `2.4`.
 
164
In the following descriptions, `PREFIX` is what you used with the `setup.py` command, or a default location if you didn't use the `--prefix` option. (Typical default values on Linux are `/usr` and `/usr/local`.) `X.Y` is the version of Python. Typically, this is `2.3`, `2.4` or `2.5`.
159
165
 
160
166
Look into `install.log` to find out about following important locations:
161
167