dbe2c2cfe6790fb82b8a7812a218a9ff8462c967
[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 buildroot
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
16         
17         4. Run ./scripts/feeds install luci-lua ffluci
18         
19         5. Type make menuconfig and you will find ffluci in the menu "Administration"
20         
21                 
22 2. Kamikaze Packages
23         1.      At first make sure you already added "libreadline" from
24                 the OpenWRT Packages repository to your buildroot's "package" directory
25          
26         2.      cd to the "package" directory of your kamikaze buildroot
27         
28         3.      Type: ln -s /path/to/ff-luci/contrib/package/* ./
29         
30         4.      cd to your kamikaze build root and type: make menuconfig
31                 You will find ffluci in the menu "Administration"
32
33
34 3. Manual Installation
35         Prerequisites:
36                 CGI enabled webserver
37                 Lua 5.1.x or later
38                 Luaposix Lua extension
39                 Haserl 0.9.23 or later with Lua support builtin
40         
41         Installation:
42         Use make to build a distribution of FFLuCI
43                 make: creates the source distribution with freifunk config pages
44                 make dist-compile: same as above but bytecompiles lua modules
45                 
46                 make source-examples: creates a plain distribution with example pages
47                 make dist-examples: same as above but bytecompiles lua modules
48                 
49                 make source: creates a plain distribution without pages
50                 make compile: same as above but bytecompiles lua modules
51                 
52         Put the ffluci dist/ffluci directory somewhere on your harddrive
53         e.g. in your Lua Path
54         
55         Put a bootstrap file like the one in contrib/ffluci into your webservers
56         CGI-Directory and adapt it to your needs.
57         
58         Also have a look at dist/ffluci/config.lua for configuration options.