root/trunk/nuxleus/Documentation/GettingStarted.rst

Revision 4153, 2.1 kB (checked in by ionrock, 1 year ago)

A super simple getting started guide based off IRC conversations. It
is in reStructuredText so you can use http://rst2a.com to create
things like PDFs or HTML.

Line 
1 ==========================================
2  Getting Started with Nuxleus Development
3 ==========================================
4
5 First off check out nuxleus from the repo on google code.
6
7 svn co http://nuxleus.googlecode.com/svn/trunk/nuxcleus .
8
9 You will be specifically working with the "nuxleus" directory.
10
11 Building Nuxleus
12 ================
13
14 To build Nuxleus you will be using nant. You will also be using mono
15 so be sure you have already installed the mono runtime. You will also
16 need to have Python 2.5 installed.
17
18 You can build nuxleus by typing "nant" in the nuxleus directory. That
19 will build everything and you will have a "~/nuxleus/src/build/"
20 directory that contains the built dlls. This also contains a copy of
21 xsp2.exe, the mono web server.
22
23
24 Running Nuxleus
25 ===============
26
27 To actually run the server a few things need to happen. First, the
28 queue server must be run. This depends on Memcache also being run on
29 port 9876.
30
31
32 The Queue Server
33 ----------------
34
35 The Queue Server is a python applcation you will need to install. To
36 install the app along with the necessary libaries, go to
37 "~/nuxleus/src/Dependencies/Queue/" where you will find a set of
38 directories. You will want to install all these libraries in the
39 following order.
40
41   - axon
42   - kaemalia
43   - cherrypy
44   - bridge
45   - bucker
46   - python-memcached-1.40
47   - llup
48
49 The most important piece is that axon and kaemalia get installed first
50 as the following packages such as llup and bucker require them. To
51 actually install the libraries, go into the directory and run:
52
53   python setup.py install
54
55 With the libararies and queue server installed you can start it via
56 a shell script with:
57  
58   ~/nuxleus/Scripts/qs.sh start
59
60 You will also need to get memcache up and running via:
61
62   memcached -d
63
64
65 Starting Nuxleus
66 ----------------
67
68 With the Queue Server running you can start the actual web server that
69 will accept requests. To start the server:
70
71   mono ~/nuxleus/src/build/bin/xsp2.exe ~/nuxleus/Web/Development/
72
73 That will start the server and it will use the files in the
74 "~/nuxleus/Web/Development/" directory for handling requests.
75
76 You should now be able to visit http://localhost:8080 to see the
77 application running.
Note: See TracBrowser for help on using the browser.