changeset 84:2f9b41699a7f

docs: update docs about moin script usage
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sun, 06 Mar 2011 23:49:33 +0100
parents 8a5be4814a48
children 0944980db255
files docs/admin/install.rst docs/admin/serve.rst
diffstat 2 files changed, 37 insertions(+), 22 deletions(-) [+]
line wrap: on
line diff
--- a/docs/admin/install.rst	Sun Mar 06 22:47:02 2011 +0100
+++ b/docs/admin/install.rst	Sun Mar 06 23:49:33 2011 +0100
@@ -37,15 +37,11 @@
 a while.
 It will also compile the translations (`*.po` files) to binary `*.mo` files.
 
-Note: in this special mode, it won't copy moin to the env/ directory, it will
-run everything from your work dir, so you can modify code and directly try it
-out (you only need to do this installation procedure once).
-
-After successfully installing, you can enter the virtual env and start moin by::
+Further, it will create a "moin" script for your platform which you can use
+for starting moin (the builtin server) or invoke moin script commands. It will
+be in the PATH, so just type "moin" on the shell / cmd.
 
- source env/bin/activate
- ./moin
+Note: in this special mode, it won't copy the MoinMoin code to the env/
+directory, it will run everything from your work dir, so you can modify code
+and directly try it out (you only need to do this installation procedure once).
 
-We activate that virtual environment, so moin will find all its dependencies
-and finally start the builtin server using the `moin` script.
-
--- a/docs/admin/serve.rst	Sun Mar 06 22:47:02 2011 +0100
+++ b/docs/admin/serve.rst	Sun Mar 06 23:49:33 2011 +0100
@@ -9,22 +9,41 @@
 
 It is not made for serving bigger loads, but it is easy to use.
 
-To start moin using the builtin web server, just run "moin".
-
-If you'ld like to see all subcommands and options of the moin command, use::
-
- $ ./moin help
- $ ./moin moin --help
+Entering the virtual env
+------------------------
+If you installed to a virtualenv, you need to activate it first, so it will
+find the moin script, the moin code and all its library dependencies::
 
-**Example**::
-
- $ ./moin moin --config /srv/wiki/wikiconfig.py --host 1.2.3.4 --port 7777
+ source env/bin/activate  # for linux (or other posix OSes)
+ # or
+ call env\bin\activate  # for windows
 
-Use an absolute path for the wikiconfig.py!
+Running the builtin server
+--------------------------
+Then you can run the moin builtin server by::
 
-.. todo::
+ moin
+ # or, if you need another ip/port:
+ moin moin --config /path/to/wikiconfig.py --host 1.2.3.4 --port 7777
 
-   add stuff above to man page and reference man page from here
+Now moin starts the builtin server and tries to locate the wiki configuration
+from (please use an absolute path):
+
+- commandline argument `--config /path/to/wikiconfig.py`
+- environment variable `MOINCFG=/path/to/wikiconfig.py`
+- current directory, file `wikiconfig_local.py`
+- current directory, file `wikiconfig.py`
+
+While the moin server is starting up, you will see some log output like::
+
+ 2011-03-06 23:35:11,445 INFO werkzeug:116  * Running on http://127.0.0.1:8080/
+
+Now point your browser at that URL - your moin wiki is running!
+
+Stopping the builtin server
+---------------------------
+To stop the wiki server, either use `Ctrl-C` or close the window.
+
 
 External Web Server (advanced)
 ==============================