(no commit message)
[project/luci.git] / INSTALL
1 FFLuCI Installation Instructions
2
3 TOC:
4 1. Kamikaze Feed
5 2. Kamikaze Packages
6 3. Manual Installation
7
8
9 1. Kamikaze Feed
10         1. Change to your OpenWRT buldroot
11
12         2. Add the following line to your OpenWRT feeds.conf:
13                 src-svn ffluci https://dev.leipzig.freifunk.net/svn/ff-luci/trunk/contrib/package
14                 
15         3. Run ./scripts/feeds update ffluci
16         
17         4. Type make menuconfig and you will find ffluci in the menu "Administration"
18         
19                 
20 2. Kamikaze Packages
21         1.      At first make sure you already added "lua" from
22                 the OpenWRT Packages repository to your buildroot's "package" directory
23          
24         2.      cd to the "package" directory of your kamikaze buildroot
25         
26         3.      Type: ln -s /path/to/ff-luci/contrib/package/* ./
27         
28         4.      cd to your kamikaze build root and type: make menuconfig
29                 You will find ffluci in the menu "Administration"
30
31
32 3. Manual Installation
33         Prerequisites:
34                 CGI enabled webserver
35                 Lua 5.1.x or later
36                 LuaFileSystem Lua extension
37                 Haserl 0.9x or later with Lua support builtin
38         
39         Installation:
40         Use make to build a distribution of FFLuCI
41                 make: creates the source distribution with freifunk config pages
42                 make dist-compile: same as above but bytecompiles lua modules
43                 
44                 make source-examples: creates a plain distribution with example pages
45                 make dist-examples: same as above but bytecompiles lua modules
46                 
47                 make source: creates a plain distribution without pages
48                 make compile: same as above but bytecompiles lua modules
49                 
50         Put the ffluci dist/ffluci directory somewhere on your harddrive
51         e.g. in your Lua Path
52         
53         Put a bootstrap file like the one in contrib/ffluci into your webservers
54         CGI-Directory and adapt it to your needs.
55         
56         Also have a look at dist/ffluci/config.lua for configuration options.