2007-07-16 21:03:39 +00:00
|
|
|
To use Luminotes, please see the included README file instead of this INSTALL
|
|
|
|
file. This file contains details about installing the Luminotes server, which
|
|
|
|
you shouldn't need if you only want to make a wiki.
|
2007-07-16 20:22:38 +00:00
|
|
|
|
|
|
|
First, install the prerequisites:
|
|
|
|
|
|
|
|
* Python 2.5
|
|
|
|
* CherryPy 2.2
|
|
|
|
* simplejson 1.3
|
|
|
|
|
|
|
|
|
2007-08-01 21:25:25 +00:00
|
|
|
development mode
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Running the Luminotes server in development mode is convenient for testing out
|
|
|
|
changes, because it uses CherryPy's built-in web server with auto-reload
|
|
|
|
enabled, so the server will automatically reload any modified source files as
|
|
|
|
soon as they're modified.
|
2007-07-16 20:22:38 +00:00
|
|
|
|
2007-08-02 04:01:11 +00:00
|
|
|
To start the server in development mode, run:
|
2007-07-16 20:22:38 +00:00
|
|
|
|
2007-07-16 21:03:39 +00:00
|
|
|
python2.5 luminotes.py -d
|
2007-07-16 20:22:38 +00:00
|
|
|
|
|
|
|
Connect to the following URL in a web browser running on the same machine:
|
|
|
|
|
2007-08-01 20:24:46 +00:00
|
|
|
http://localhost:8081/
|
2007-07-16 20:22:38 +00:00
|
|
|
|
|
|
|
|
2007-08-01 21:25:25 +00:00
|
|
|
production mode
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Production mode is intended for a live production web site, so you can skip
|
|
|
|
this section entirely if you don't care about running such a site. Production
|
|
|
|
mode doesn't support auto-reload, and logging goes to file (luminotes.log)
|
|
|
|
instead of the console, but performance should be better than in development
|
|
|
|
mode.
|
|
|
|
|
2007-08-02 18:52:20 +00:00
|
|
|
If you want to use SSL, edit config/Common.py and change the values of
|
|
|
|
luminotes.http_url and luminotes.https_url based on the domain you're using.
|
|
|
|
For instance:
|
2007-08-01 21:25:25 +00:00
|
|
|
|
2007-08-02 18:52:20 +00:00
|
|
|
"luminotes.http_url": "http://luminotes.com",
|
2007-08-02 04:01:11 +00:00
|
|
|
"luminotes.https_url": "https://luminotes.com",
|
2007-08-01 21:25:25 +00:00
|
|
|
|
|
|
|
Then you'll need to configure your web server to forward requests for
|
|
|
|
non-static pages to CherryPy. These instructions are for Apache, but in
|
|
|
|
theory, Luminotes should work with just about any web server.
|
|
|
|
|
2007-08-03 19:43:16 +00:00
|
|
|
In your Apache configuration file, enable mod_rewrite and mod_proxy, then add
|
|
|
|
the following rewrite rules to the settings for your VirtualHost:
|
2007-08-01 21:25:25 +00:00
|
|
|
|
|
|
|
RewriteEngine on
|
|
|
|
RewriteRule ^/favicon.ico /path/to/luminotes/static/images/favicon.ico [L]
|
|
|
|
RewriteRule ^/static/(.*) /path/to/luminotes/static/$1 [L]
|
|
|
|
RewriteRule ^(.*) http://127.0.0.1:8081$1 [P]
|
|
|
|
|
2007-08-03 19:43:16 +00:00
|
|
|
You should change the paths in the rules above to point to wherever Luminotes
|
|
|
|
happens to be installed. These rules cause Apache to serve static files
|
|
|
|
itself, while passing through requests for dynamic pages to the CherryPy web
|
|
|
|
server running locally.
|
|
|
|
|
|
|
|
If you want to use SSL, add these same rules to the settings for your
|
|
|
|
SSL-enabled VirtualHost as well, but change the IP in the last rule from
|
|
|
|
127.0.0.1 to 127.0.0.2. This hack allows the Luminotes server to distinguish
|
|
|
|
between SSL and non-SSL requests by looking at the proxy IP. Without this,
|
|
|
|
Luminotes would have no way of knowing whether a particular request was
|
|
|
|
encrypted when received by Apache. (There are ways to do this in a less hacky
|
|
|
|
manner with Apache 2, but not Apache 1.)
|
2007-07-16 20:22:38 +00:00
|
|
|
|
2007-08-02 04:01:11 +00:00
|
|
|
To actually start the production mode server, run:
|
2007-08-01 21:25:25 +00:00
|
|
|
|
|
|
|
python2.5 luminotes.py
|
|
|
|
|
|
|
|
Then you should be able to connect to the site at whatever domain you've
|
|
|
|
configured Apache to serve.
|
|
|
|
|
|
|
|
|
|
|
|
unit tests
|
|
|
|
----------
|
|
|
|
|
|
|
|
If you're interested in running unit tests, install:
|
|
|
|
|
2007-08-02 23:25:57 +00:00
|
|
|
* nose 0.9.0
|
2007-08-01 21:25:25 +00:00
|
|
|
|
|
|
|
Then you can run unit tests by running:
|
|
|
|
|
|
|
|
nosetests
|