changeset 525:8c9bcfc22faa

Revised "Installation" section of documentation
author jbe
date Tue Aug 22 03:26:51 2017 +0200 (10 months ago)
parents 50746f1e8a43
children fe9932334bae
files doc/autodoc-header.htmlpart
line diff
     1.1 --- a/doc/autodoc-header.htmlpart	Tue Aug 22 01:35:09 2017 +0200
     1.2 +++ b/doc/autodoc-header.htmlpart	Tue Aug 22 03:26:51 2017 +0200
     1.3 @@ -95,8 +95,19 @@
     1.4      </p>
     1.5      <h2>Installation</h2>
     1.6      <p>
     1.7 -      After downloading the tar.gz package, unpack it, enter the unpacked directory and type <tt>make</tt>. If you use Mac OS X or if you experience problems during compilation, you need to edit the <tt>Makefile.options</tt> file prior to compilation. The framework itself will be available in the <tt>framework/</tt> directory, while a demo application is available in the <tt>demo-app/</tt> directory. The <tt>framework.precompiled/</tt> and <tt>demo-app.precompiled/</tt> directories will contain a version with all Lua files being byte-code pre-compiled, which can be used instead. You may copy these directories (with <tt>cp -L</tt> to follow links) to any other place you like. Don't forget to setup a database, and make the <tt>tmp/</tt> directory of the application writable for the user who executes WebMCP. Good luck and have fun!
     1.8 +      Please read the following instructions carefully to avoid problems during installation.
     1.9      </p>
    1.10 +    <ol>
    1.11 +      <li>Download and compile the <a href="http://www.public-software-group.org/moonbridge">Moonbridge Network Server for Lua Applications</a> (follow the README file of Moonbridge).</li>
    1.12 +      <li>Optional: Ensure that the <tt>moonbridge</tt> binary is within the search path for binaries.</li>
    1.13 +      <li>Optional: Ensure that the <tt>moonbridge_http.lua</tt> file is covered by Lua's <a href="https://www.lua.org/manual/5.3/manual.html#pdf-package.path">package path</a> (see Lua's <a href="https://www.lua.org/manual/5.3/manual.html#pdf-package.searchpath">search path documentation</a> on how to format the <tt>LUA_PATH</tt> environment variable).</li>
    1.14 +      <li>Download <a href="http://www.public-software-group.org/webmcp">WebMCP</a>.</li>
    1.15 +      <li>Enter WebMCP's unpacked source code directory and execute the command "<tt>make</tt>".</li>
    1.16 +      <li>If you experience problems during step&nbsp;3, edit the <tt>Makefile.options</tt> file and repeat step&nbsp;3.</li>
    1.17 +      <li>The <tt>framework/</tt> directory (or the <tt>framework.precompiled</tt> directory if you want to use precompiled code) is WebMCP's framework base directory now. It may be copied to any other directory of your choice (but make sure to follow links, e.g. using <tt>cp -L -R</tt>, when copying the directory to a different place).</li>
    1.18 +      <li>If optional step&nbsp;3 has been skipped, ensure that Moonbridge's <tt>moonbridge_http.lua</tt> file is soft-linked or copied to the <tt>lib/</tt> directory of the framework's base directory.</li>
    1.19 +      </li>
    1.20 +    </ol>
    1.21      <h2>Configuration, initializers, and request handling</h2>
    1.22      <p>
    1.23        WebMCP uses the <a href="http://www.public-software-group.org/moonbridge">Moonbridge Network Server</a> to handle HTTP requests. The Moonbridge Network Server listens to a TCP port and passes control to WebMCP by calling <a href="#request.handler"><tt>request.handler(...)</tt></a> for each request. However, before any request is processed, WebMCP will initialize the environment. This initialization includes tasks such as

Impressum / About Us