[Moin-devel] CVS: dist/wiki/data/text HelpOnInstalling_2fBasicInstallation,NONE,1.1 MoinMoin_2fInstallDocs,NONE,1.1 HelpOnConfiguration,1.7,1.8 HelpOnInstalling,1.8,1.9 HelpOnInstalling_2fApacheOnUnix,1.4,1.5 HelpOnInstalling_2fApacheOnWin32,1.3,1.4 MoinMoin,1.4,1.5
J?rgen Hermann
jhermann at users.sourceforge.net
Wed Feb 27 13:01:05 EST 2002
Update of /cvsroot/moin/dist/wiki/data/text
In directory usw-pr-cvs1:/tmp/cvs-serv23951
Modified Files:
HelpOnConfiguration HelpOnInstalling
HelpOnInstalling_2fApacheOnUnix
HelpOnInstalling_2fApacheOnWin32 MoinMoin
Added Files:
HelpOnInstalling_2fBasicInstallation MoinMoin_2fInstallDocs
Log Message:
Made /InstallDocs page for creating INSTALL.html; adapted things
accordingly
--- NEW FILE: HelpOnInstalling_2fBasicInstallation ---
== Basic Installation ==
Before you can integrate Moin``Moin into your web environment,
you have to do the basic installation using the standard Python
''distutils'' mechanism. We'll explain the usual steps you 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 of your
Python manual.
/!\ '''NOTE:''' You will need the Python Development package installed on UNIX systems for distutils to work correctly.
The first step is to unpack the distribution archive, which you
have done already when you loaded this instructions from your disk.
If you read this on the web, the distribution comes in a versioned
ZIP or TAR archive, which you can unpack in the usual ways, into a
temporary directory (`/tmp` on UNIX, `C:\TEMP` on Windows). The
distribution archive will always unpack into a directory named
`moin-<version>`, for example `moin-0.11`.
After unpacking, to install into a specific directory (`C:\moin`
in our example), call `setup.py` after changing your current
directory to the distribution directory. The following commands
can be used to complete theses steps:
{{{
unzip moin-0.11.zip
cd moin-0.11
python setup.py --quiet install --prefix=C:\moin
}}}
This creates the following directories in "C:\moin" (note
that on a UNIX system, the directory layout will be slightly
different):
{{{
MoinMoin
MoinMoin/action
MoinMoin/formatter
MoinMoin/i18n
MoinMoin/macro
MoinMoin/parser
MoinMoin/py15
MoinMoin/scripts
MoinMoin/support
MoinMoin/twisted
MoinMoin/webapi
Scripts
share
share/moin
share/moin/cgi-bin
share/moin/data
share/moin/data/backup
share/moin/data/cache
share/moin/data/pages
share/moin/data/plugin
share/moin/data/plugin/action
share/moin/data/plugin/macro
share/moin/data/text
share/moin/data/user
share/moin/htdocs
share/moin/htdocs/css
share/moin/htdocs/img
}}}
You will likely see the following warning:
warning: install: modules installed to 'C:\moin\', which
is not in Python's module search path (sys.path) -- you'll
have to change the search path yourself
This means exactly what it says, you need to add your install
directory to the search path of Python. There are several ways
to do this:
Environment variable:: Change `PYTHONPATH` in a way that is
persistent (`/etc/profile.d` on UNIX, `AUTOEXEC.BAT` on W9x,
the `Properties` item in the context menu of `My Computer` on NT4 and
W2K)
Apache "httpd.conf":: Use the `SetEnv` directive to set
`PYTHONPATH` to a suitable value, for example: {{{
SetEnv PYTHONPATH "C:\moin"
}}}
"moin.cgi":: Directly add your installation directory to
the CGI driver script, like this: {{{
import sys
sys.path.append('C:/moin')
}}}
If you use the following default installation command, Moin``Moin
will be installed to the Python directory:
{{{
python setup.py --quiet install
}}}
You won't need to change your `PYTHONPATH` then, but depending
on your system environment you might not be able to use that
command, especially when you are not the root user on a UNIX
system. If you don't know where your Python directory is, this
command will tell you:
{{{
python -c "import sys; print sys.prefix"
}}}
The directory structure we showed above will then be created
in that directory. If you're interested in the exact list of
files that are installed, use the `--record` option of distutils.
--- NEW FILE: MoinMoin_2fInstallDocs ---
#pragma section-numbers off
This HTML page contains the basic install docs that can be found on http://purl.net/wiki/moin/MoinMoin/InstallDocs. It contains all necessary information to get your wiki up and running, even without being online. If you have a permanent internet connection, you might want to browse the docs on the Help``On``Installing page, which might contain more up-to-date information.
After following the procedures on this page, you should have a working wiki and can browse the rest of the online docs there.
== How to install your own MoinMoin Wiki ==
This page describes the installation procedure applying to MoinMoin:MoinMoin version 0.11 and up. In the next section, there is a list of real-world [#installscenarios Installation Scenarios] that help you to understand how to apply the instructions in different environments.
[#basic-install Basic Installation] explains the "`setup.py`" step of the installation in more detail. This applies equally to all scenarios, and you should read it before trying a live installation.
After a successful installation, you might want to read more about configuration and other options that you, as the wiki administrator, can set up. MoinMoin:HelpOnAdministration contains links to pages that cover these topics.
Especially, the MoinMoin:HelpOnConfiguration and MoinMoin:HelpOnUpdating pages provide additional information regarding wiki setup and maintenance. MoinMoin:MoinMoinWinCvs and MoinMoin:MoinMoinUnixCvs describe how to run your wiki using the current development version from the MoinMoin:SourceForge CVS repository.
[[Anchor(installscenarios)]]
=== Sample Installation Scenarios ===
The following links lead you to concrete examples of installation sessions, showing the commands used and explaining what they do. It is highly recommended that you ''first'' read the general information on installing (especially the next section of this page) before choosing an installation scenario that best fits your intended use of MoinMoin:MoinMoin.
UNIX:
* [#unix-install UNIX Installation]
Windows:
* [#win32apache-install Windows Installation using Apache]
* [#win32iis-install Windows Installation using IIS]
[[Anchor(basic-install)]]
[[Include(HelpOnInstalling/BasicInstallation)]]
------
[[Anchor(unix-install)]]
------
[[Include(HelpOnInstalling/ApacheOnUnix, "UNIX Installation", 1)]]
------
[[Anchor(win32apache-install)]]
------
[[Include(HelpOnInstalling/ApacheOnWin32, "Windows Installation using Apache", 1)]]
------
[[Anchor(win32iis-install)]]
------
[[Include(HelpOnInstalling/InternetInformationServer, "Windows Installation using IIS", 1)]]
Index: HelpOnConfiguration
===================================================================
RCS file: /cvsroot/moin/dist/wiki/data/text/HelpOnConfiguration,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -r1.7 -r1.8
*** HelpOnConfiguration 20 Feb 2002 20:57:58 -0000 1.7
--- HelpOnConfiguration 27 Feb 2002 21:00:42 -0000 1.8
***************
*** 7,14 ****
--- 7,19 ----
* /EmailSupport
+ '''Index'''
+ [[TableOfContents]]
+
== Configuration of MoinMoin ==
MoinMoin is configured by changing the `moin_config.py` file, which normally sits besides your `moin.cgi` driver script. `moin_config.py` is imported by the MoinMoin main code early in a request cycle and is found because the current directory (i.e. that of `moin.cgi`) is part of the Python system path. Consequently, `moin_config.py` can sit anywhere in your `PYTHONPATH`.
+ === Overview of configuration options ===
+
The following table contains default values and a short description for all configuration variables. Most of these can be left at their defaults, those you need to change with every installation are listed in the sample `moin_config.py` that comes with the distribution.
***************
*** 73,74 ****
--- 78,93 ----
|| url_prefix || '/wiki-moinmoin' || Used as the base URL for all public documents served by the wiki, especially the image files for the icons ||
|| url_schemas || [] || additional URL schemas you want to have recognized (list of strings) ||
+
+
+ === Changing character sets ===
+
+ If you want to use MoinMoin with a character set other than Latin-1, you
+ might or even have to change the default character sets for WikiName``s in
+ "moin_config.py". A safe default is US-ASCII, i.e. {{{
+ upperletters = "A-Z"
+ lowerletters = "0-9a-z"
+ }}}
+
+ With that setting, you need to set "`allow_extended_names=1`" and use the
+ special markup for extended WikiName``s `["extended name"]` to get any names
+ with characters outside the core latin alphabet.
Index: HelpOnInstalling
===================================================================
RCS file: /cvsroot/moin/dist/wiki/data/text/HelpOnInstalling,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -r1.8 -r1.9
*** HelpOnInstalling 26 Feb 2002 00:59:49 -0000 1.8
--- HelpOnInstalling 27 Feb 2002 21:00:42 -0000 1.9
***************
*** 8,18 ****
This page describes the installation procedure applying to MoinMoin version 0.11 and up. In the next section, there is a list of real-world [#installscenarios Installation Scenarios] that help you to understand how to apply the instructions in different environments.
! Further down the page, [#installbasics Basic Installation] explains the "`setup.py`" step of the installation in more detail. This applies equally to all scenarios, and you should read it before trying a live installation.
After a successful installation, you might want to read more about configuration and other options that you, as the wiki administrator, can set up. HelpOnAdministration contains links to pages that cover these topics.
Especially, the HelpOnConfiguration and HelpOnUpdating pages provide additional information regarding wiki setup and maintenance. MoinMoin:MoinMoinWinCvs and MoinMoin:MoinMoinUnixCvs describe how to run your wiki using the current development version from the MoinMoin:SourceForge CVS repository.
- MoinMoin installation instructions of previous versions can be found in the file '{{{INSTALL}}}' in the directory "{{{moin-}}}''version''" after unpacking the distribution archive. In the web, you can find this file [http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/moin/dist/INSTALL?rev=HEAD&content-type=text/vnd.viewcvs-markup here]. For Windows systems running IIS or PWS, consult [http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/moin/dist/INSTALL.IIS?rev=HEAD&content-type=text/vnd.viewcvs-markup INSTALL.IIS]. These INSTALL files describe the installation procedure ''before'' distutils support was added.
-
[[Anchor(installscenarios)]]
--- 8,16 ----
This page describes the installation procedure applying to MoinMoin version 0.11 and up. In the next section, there is a list of real-world [#installscenarios Installation Scenarios] that help you to understand how to apply the instructions in different environments.
! /BasicInstallation explains the "`setup.py`" step of the installation in more detail. This applies equally to all scenarios, and you should read it before trying a live installation.
After a successful installation, you might want to read more about configuration and other options that you, as the wiki administrator, can set up. HelpOnAdministration contains links to pages that cover these topics.
Especially, the HelpOnConfiguration and HelpOnUpdating pages provide additional information regarding wiki setup and maintenance. MoinMoin:MoinMoinWinCvs and MoinMoin:MoinMoinUnixCvs describe how to run your wiki using the current development version from the MoinMoin:SourceForge CVS repository.
[[Anchor(installscenarios)]]
***************
*** 30,140 ****
Macintosh:
* /ApacheOnMacOsx
-
-
- [[Anchor(installbasics)]]
- === Basic Installation ===
-
- Before you can integrate MoinMoin into your web environment,
- you have to do the basic installation using the standard Python
- ''distutils'' mechanism. We'll explain the usual steps you 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 of your
- Python manual.
-
- /!\ '''NOTE:''' You will need the Python Development package installed on UNIX systems for distutils to work correctly.
-
- The first step is to unpack the distribution archive, which you
- have done already when you loaded this instructions from your disk.
- If you read this on the web, the distribution comes in a versioned
- ZIP or TAR archive, which you can unpack in the usual ways, into a
- temporary directory (`/tmp` on UNIX, `C:\TEMP` on Windows). The
- distribution archive will always unpack into a directory named
- `moin-<version>`, for example `moin-0.11`.
-
- After unpacking, to install into a specific directory (`C:\moin`
- in our example), call `setup.py` after changing your current
- directory to the distribution directory. The following commands
- can be used to complete theses steps:
- {{{
- unzip moin-0.11.zip
- cd moin-0.11
- python setup.py --quiet install --prefix=C:\moin
- }}}
-
- This creates the following directories in "C:\moin" (note
- that on a UNIX system, the directory layout will be slightly
- different):
- {{{
- MoinMoin
- MoinMoin/action
- MoinMoin/formatter
- MoinMoin/i18n
- MoinMoin/macro
- MoinMoin/parser
- MoinMoin/py15
- MoinMoin/scripts
- MoinMoin/support
- MoinMoin/twisted
- MoinMoin/webapi
- Scripts
- share
- share/moin
- share/moin/cgi-bin
- share/moin/data
- share/moin/data/backup
- share/moin/data/cache
- share/moin/data/pages
- share/moin/data/plugin
- share/moin/data/plugin/action
- share/moin/data/plugin/macro
- share/moin/data/text
- share/moin/data/user
- share/moin/htdocs
- share/moin/htdocs/css
- share/moin/htdocs/img
- }}}
-
- You will likely see the following warning:
-
- warning: install: modules installed to 'C:\moin\', which
- is not in Python's module search path (sys.path) -- you'll
- have to change the search path yourself
-
- This means exactly what it says, you need to add your install
- directory to the search path of Python. There are several ways
- to do this:
-
- Environment variable:: Change `PYTHONPATH` in a way that is
- persistent (`/etc/profile.d` on UNIX, `AUTOEXEC.BAT` on W9x,
- the `Properties` item in the context menu of `My Computer` on NT4 and
- W2K)
-
- Apache "httpd.conf":: Use the `SetEnv` directive to set
- `PYTHONPATH` to a suitable value, for example: {{{
- SetEnv PYTHONPATH "C:\moin"
- }}}
-
- "moin.cgi":: Directly add your installation directory to
- the CGI driver script, like this: {{{
- import sys
- sys.path.append('C:/moin')
- }}}
-
- If you use the following default installation command, MoinMoin
- will be installed to the Python directory:
- {{{
- python setup.py --quiet install
- }}}
-
- You won't need to change your `PYTHONPATH` then, but depending
- on your system environment you might not be able to use that
- command, especially when you are not the root user on a UNIX
- system. If you don't know where your Python directory is, this
- command will tell you:
- {{{
- python -c "import sys; print sys.prefix"
- }}}
-
- The directory structure we showed above will then be created
- in that directory. If you're interested in the exact list of
- files that are installed, use the `--record` option of distutils.
--- 28,29 ----
Index: HelpOnInstalling_2fApacheOnUnix
===================================================================
RCS file: /cvsroot/moin/dist/wiki/data/text/HelpOnInstalling_2fApacheOnUnix,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** HelpOnInstalling_2fApacheOnUnix 26 Feb 2002 21:39:46 -0000 1.4
--- HelpOnInstalling_2fApacheOnUnix 27 Feb 2002 21:00:43 -0000 1.5
***************
*** 10,14 ****
== Installation when you are root or the webmaster ==
! When you are root or the webmaster on the host you want to install MoinMoin on, you can place the software in a "standard" location, and also better integrate MoinMoin into your webserver. Especially, you can use a "nice" base URL that does not include "cgi-bin" or "moin.cgi" at all.
Most GNU/Linux distributions come with Apache pre-installed. In the following description, we assume the file system layout of a SuSE 7.0 system, that is:
--- 10,14 ----
== Installation when you are root or the webmaster ==
! When you are root or the webmaster on the host you want to install Moin``Moin on, you can place the software in a "standard" location, and also better integrate Moin``Moin into your webserver. Especially, you can use a "nice" base URL that does not include "cgi-bin" or "moin.cgi" at all.
Most GNU/Linux distributions come with Apache pre-installed. In the following description, we assume the file system layout of a SuSE 7.0 system, that is:
***************
*** 18,22 ****
=== Installing MoinMoin ===
! Before creating a wiki instance, you have to download and install the basic MoinMoin software. We assume you already have downloaded the distribution archive to "`/tmp`" [[FootNote(If you want to install the current development version from CVS, replace "/tmp" with your "moin" working directory.)]].
Open a shell and enter the following commands:
--- 18,22 ----
=== Installing MoinMoin ===
! Before creating a wiki instance, you have to download and install the basic Moin``Moin software. We assume you already have downloaded the distribution archive to "`/tmp`" [[FootNote(If you want to install the current development version from CVS, replace "/tmp" with your "moin" working directory.)]].
Open a shell and enter the following commands:
***************
*** 64,68 ****
The first line you only need once; the second line is needed once for each wiki instance (of course, each one with another wiki name and path).
! That is all, '''restart your Apache server''' ("`/etc/rc.d/apache restart`" on SuSE) and try to access your new-born wiki with the URL "`http://127.0.0.1/mywiki/`". You should see the FrontPage, try to edit and save it, and if that works, see if your edit is reflected on the RecentChanges page.
Finally, edit "`moin_config.py`" and at least change "`sitename`" and "`logo_url`" to some personal values:
--- 64,68 ----
The first line you only need once; the second line is needed once for each wiki instance (of course, each one with another wiki name and path).
! That is all, '''restart your Apache server''' ("`/etc/rc.d/apache restart`" on SuSE) and try to access your new-born wiki with the URL "`http://127.0.0.1/mywiki/`". You should see the Front``Page, try to edit and save it, and if that works, see if your edit is reflected on the Recent``Changes page.
Finally, edit "`moin_config.py`" and at least change "`sitename`" and "`logo_url`" to some personal values:
***************
*** 93,97 ****
== Installation into your home directory ==
! Installation into your shell account's home directory is typically used on a host shared by many users and where you are ''not'' the root user. This usually implies that you cannot change the `httpd.conf` file, and also you cannot copy files into the machine's `cgi-bin` and `htdocs` directories. For this situation, Apache includes the `UserDir` directive, which maps all URLs that start with "`/~username`" to a directory in your home directory, where you have write permissions and thus can install MoinMoin.
--- 93,97 ----
== Installation into your home directory ==
! Installation into your shell account's home directory is typically used on a host shared by many users and where you are ''not'' the root user. This usually implies that you cannot change the `httpd.conf` file, and also you cannot copy files into the machine's `cgi-bin` and `htdocs` directories. For this situation, Apache includes the `UserDir` directive, which maps all URLs that start with "`/~username`" to a directory in your home directory, where you have write permissions and thus can install Moin``Moin.
***************
*** 147,151 ****
}}}
! This will install the MoinMoin software into the directories
"`~/lib/python/MoinMoin`",
"`~/bin`",
--- 147,151 ----
}}}
! This will install the Moin``Moin software into the directories
"`~/lib/python/MoinMoin`",
"`~/bin`",
Index: HelpOnInstalling_2fApacheOnWin32
===================================================================
RCS file: /cvsroot/moin/dist/wiki/data/text/HelpOnInstalling_2fApacheOnWin32,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** HelpOnInstalling_2fApacheOnWin32 27 Feb 2002 19:25:13 -0000 1.3
--- HelpOnInstalling_2fApacheOnWin32 27 Feb 2002 21:00:43 -0000 1.4
***************
*** 4,13 ****
== Requirements ==
! Before you install MoinMoin, make sure you have the necessary infra-structure in place, namely the ''Apache for Microsoft Windows'' webserver, and a ''Python'' installation (version 2.0 or higher is recommended, don't run 1.5.2 without a compelling reason).
In the following description, we assume that you have installed or will install things to these locations:
* `C:\Apache` - the webserver
* `C:\Python` - the Python interpreter
! * `C:\Moin` - MoinMoin itself
Quite often, you might want to install things elsewhere, which is no problem at all; you just have to adapt any paths that appear in a command or config file to the locations you have chosen.
--- 4,13 ----
== Requirements ==
! Before you install Moin``Moin, make sure you have the necessary infra-structure in place, namely the ''Apache for Microsoft Windows'' webserver, and a ''Python'' installation (version 2.0 or higher is recommended, don't run 1.5.2 without a compelling reason).
In the following description, we assume that you have installed or will install things to these locations:
* `C:\Apache` - the webserver
* `C:\Python` - the Python interpreter
! * `C:\Moin` - Moin``Moin itself
Quite often, you might want to install things elsewhere, which is no problem at all; you just have to adapt any paths that appear in a command or config file to the locations you have chosen.
***************
*** 19,23 ****
=== Installing Apache ===
! You currently need an external webserver to run MoinMoin, the recommended option is to use Apache if you haven't installed one on your machine already. To install Apache, consult the [http://httpd.apache.org/docs/windows.html Using Apache With Microsoft Windows] document. Make sure that your webserver runs without problems before you start to install MoinMoin; problems with your webserver installation are not in the scope of this document.
=== Installing Python ===
--- 19,23 ----
=== Installing Apache ===
! You currently need an external webserver to run Moin``Moin, the recommended option is to use Apache if you haven't installed one on your machine already. To install Apache, consult the [http://httpd.apache.org/docs/windows.html Using Apache With Microsoft Windows] document. Make sure that your webserver runs without problems before you start to install Moin``Moin; problems with your webserver installation are not in the scope of this document.
=== Installing Python ===
***************
*** 27,31 ****
=== Installing MoinMoin ===
! Before creating a wiki instance, you have to download and install the basic MoinMoin software. We assume you already have downloaded the distribution archive to the "`C:\TEMP`" directory[[FootNote(If you want to install the current development version from CVS, replace "C:\TEMP" with your "moin" working directory.)]].
Open a console window and enter the following commands:
--- 27,31 ----
=== Installing MoinMoin ===
! Before creating a wiki instance, you have to download and install the basic Moin``Moin software. We assume you already have downloaded the distribution archive to the "`C:\TEMP`" directory[[FootNote(If you want to install the current development version from CVS, replace "C:\TEMP" with your "moin" working directory.)]].
Open a console window and enter the following commands:
***************
*** 76,80 ****
The first line you only need once; the second line is needed once for each wiki instance (of course, each one with another wiki name and path).
! That is all, '''restart your Apache server''' and try to access your new-born wiki with the URL "`http://127.0.0.1/mywiki/`". You should see the FrontPage, try to edit and save it, and if that works, see if your edit is reflected on the RecentChanges page.
Finally, edit "`moin_config.py`" and at least change "`sitename`" and "`logo_url`" to some personal values:
--- 76,80 ----
The first line you only need once; the second line is needed once for each wiki instance (of course, each one with another wiki name and path).
! That is all, '''restart your Apache server''' and try to access your new-born wiki with the URL "`http://127.0.0.1/mywiki/`". You should see the Front``Page, try to edit and save it, and if that works, see if your edit is reflected on the Recent``Changes page.
Finally, edit "`moin_config.py`" and at least change "`sitename`" and "`logo_url`" to some personal values:
Index: MoinMoin
===================================================================
RCS file: /cvsroot/moin/dist/wiki/data/text/MoinMoin,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** MoinMoin 17 Feb 2002 21:20:18 -0000 1.4
--- MoinMoin 27 Feb 2002 21:00:43 -0000 1.5
***************
*** 12,15 ****
--- 12,16 ----
* MoinMoin:MoinMoinMailingLists - discussion about MoinMoin via email
* MoinMoin:MoinMoinWikis - list of wiki sites using MoinMoin
+ * /InstallDocs - all the help pages about installation rolled into one
Other pages about MoinMoin:
More information about the Moin-devel
mailing list