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