Difuse/luci
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

luci-app-example: improve description

Browse source 
Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
This commit is contained in:
Sergey Ponomarev 2022-10-13 14:27:15 +03:00
parent b0b9a34f8b
commit 7b073526a6
2 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
applications/luci-app-example/README.md
View file

@ -2,10 +2,24 @@
This app is meant to be a kind of template, example or starting point for developing new luci apps.
It provides two pages in the admin backend. One is based on a view with a form and makes use of internal models. The other one uses the `E()`-method to create more flexibel pages.
It provides two pages in the admin backend:
* [htmlview.js](./htdocs/luci-static/resources/view/example/htmlview.js) is based on a view with a form and makes use of internal models.
* [form.js](./htdocs/luci-static/resources/view/example/form.js) uses the `E()` method to create more flexible pages.
The view based page is used to modify the example configuration.
The html view page just shows the configured values.
The configuration is stored in `/etc/config/example`.
The file must exist and created on device boot by UCI defaults script in `/root/etc/uci-defaults/80_example`.
More details about the UCI defaults https://openwrt.org/docs/guide-developer/uci-defaults
To install the luci-app-example to your OpenWrt instance use:
```
scp -r root/* root@192.168.1.1:/
scp -r htdocs/* root@192.168.1.1:/www/
# execute the UCI defaults script to create the /etc/config/example
ssh root@192.168.1.1 "sh /etc/uci-defaults/80_example"
```
Then you need to re-login to LUCI and you'll see a new Example item in main menu.

2
applications/luci-app-example/root/usr/share/rpcd/acl.d/luci-app-example.json
View file

@ -1,6 +1,6 @@
{
"luci-app-example": {
"description": "Grant UCI access to LuCI app ecample",
"description": "Grant UCI access to LuCI app example",
"read": {
"ubus": {
"uci": [