mirror of
https://github.com/mkschreder/juci.git
synced 2025-01-07 03:16:39 +08:00
Cleanup
Signed-off-by: Martin Schröder <mkschreder.uk@gmail.com>
This commit is contained in:
Martin Schröder
parent
442cd87fb3
commit
5a36c9a7a9
114
README.md
114
README.md
@ -1,11 +1,12 @@
|
||||
JUCI Webgui for Embedded Routers
|
||||
--------------------------------
|
||||
|
||||
Date: 19 Dec 2016
|
||||
Author: Martin K. Schröder <mkschreder.uk@gmail.com>
|
||||
Author: Martin K. Schröder <mkschreder.uk@gmail.com>
|
||||
|
||||
* Latest version of juci is v2.16.12
|
||||
* Juci feed for openwrt with all other packages that juci depends on can be found here: https://github.com/mkschreder/juci-openwrt-feed.git
|
||||
* Juci feed for openwrt with all other packages that juci depends on can be
|
||||
found here: https://github.com/mkschreder/juci-openwrt-feed.git
|
||||
|
||||
JUCI architecture looks roughly like this:
|
||||
|
||||
|
||||
@ -19,20 +20,22 @@ JUCI is theme-able and fully mobile-ready (responsive):
|
||||
|
||||
|
||||
|
||||
Update: new build instructions available!
|
||||
|
||||
JUCI is modern web interface developed for OpenWRT-based embedded devices. It
|
||||
is built using HTML5 and angular.js and uses websockets for communicating with
|
||||
a compact and fast lua backend running on the embedded device. You can build
|
||||
both the frontend application and the backend server independently of each
|
||||
other and use them separately.
|
||||
|
||||
The OrangeRPCD project which JUCI uses as it's websocket based backend RPC server
|
||||
can be found here: [https://github.com/mkschreder/orangerpcd.git](https://github.com/mkschreder/orangerpcd.git).
|
||||
The OrangeRPCD project which JUCI uses as it's websocket based backend RPC
|
||||
server can be found here:
|
||||
[https://github.com/mkschreder/orangerpcd.git](https://github.com/mkschreder/orangerpcd.git).
|
||||
|
||||
JUCI Documentation in HTML form can be found here: [http://mkschreder.github.io/juci](http://mkschreder.github.io/juci/)
|
||||
JUCI Documentation in HTML form can be found here:
|
||||
[http://mkschreder.github.io/juci](http://mkschreder.github.io/juci/)
|
||||
|
||||
It is recommended that you start by reading overview of how juci works found here: [http://mkschreder.github.io/juci/manual/how-juci-works.html](http://mkschreder.github.io/juci/manual/how-juci-works.html)
|
||||
It is recommended that you start by reading overview of how juci works found
|
||||
here:
|
||||
[http://mkschreder.github.io/juci/manual/how-juci-works.html](http://mkschreder.github.io/juci/manual/how-juci-works.html)
|
||||
|
||||
JUCI Flash and Memory Requirements (actual runtime usage):
|
||||
|
||||
@ -40,12 +43,10 @@ JUCI Flash and Memory Requirements (actual runtime usage):
|
||||
- ~160k flash for backend rpc server (revorpcd)
|
||||
- 16M ram (revorpcd + lighttpd server)
|
||||
|
||||
|
||||
News
|
||||
----
|
||||
|
||||
Latest version of juci is 2.16.05.
|
||||
Latest release of juci is 2.16.02 (Orange Sunrize)
|
||||
|
||||
Release notes:
|
||||
- Removed plugins that do not work on OpenWRT.
|
||||
@ -54,7 +55,7 @@ Release notes version 2.16.03:
|
||||
- Moved backend to a specialized juci server and removed dependency on ubus in
|
||||
the backend (see motivation below)
|
||||
|
||||
Removing ubus dependency (Feb 2016)
|
||||
Removing ubus dependency (Feb 2016)
|
||||
-----------------------------------
|
||||
|
||||
Original juci server was using ubus as it's primary way to organize backend
|
||||
@ -112,23 +113,6 @@ If offers you the following:
|
||||
application. Also featuring quick debug mode for translations where you can
|
||||
see which strings are missing in currently used language pack.
|
||||
|
||||
How to support JUCI
|
||||
-------------------
|
||||
|
||||
To support JUCI project (or any other GPL project) you can hire one of JUCI
|
||||
developers on contract basis to help you develop your particular product. You
|
||||
get plenty of code already in the repository free of charge under the terms of
|
||||
GPL - and you also get plenty of new features added on your demand. Depending
|
||||
on their availability, developers may have variable ammounts of time to put
|
||||
into your project. To get list of JUCI developers, you can clone this repo and
|
||||
run git shortlog command.
|
||||
|
||||
git shortlog -s -e -n
|
||||
|
||||
Since JUCI is distributed under the terms of GPL, you must also be aware that
|
||||
any functionality implemented just for you, must, by definition, also fall into
|
||||
GPL.
|
||||
|
||||
Usage on OpenWRT
|
||||
----------------
|
||||
|
||||
@ -234,67 +218,10 @@ and so you will not be able to login.
|
||||
JUCI also includes a nodejs server which you can do for local testing and for
|
||||
forwarding jsonrpc calls to your router during testing (juci-local-server).
|
||||
|
||||
The GPL
|
||||
-------
|
||||
|
||||
|
||||
|
||||
JUCI project chooses the GPL because GPL is a license that protects software
|
||||
freedom. Freedom for software means that the software can move around the world
|
||||
and that every developer, anywhere, has freedom to adopt software to solve his
|
||||
specific problems. However, for this freedom to be lasting and perpetual it
|
||||
must follow that you as recipient of this software must also give the same
|
||||
freedoms to anyone else to whom you redistribute it.
|
||||
|
||||
GPL puts this idea into written form. Therefore JUCI is distributed under the
|
||||
GPLv3 as the most flexible of the freedom licenses which protects the freedoms
|
||||
of both software and your freedoms as the user who chooses to use this software
|
||||
and build products with it.
|
||||
|
||||
GPL (regardless of version) means that you as the user of the JUCI project
|
||||
(whether you use it commercially or privately) are always protected by law to
|
||||
exercise the four freedoms of GPL software:
|
||||
|
||||
- the freedom to run it
|
||||
- the freedom to study it
|
||||
- the freedom to redistribute it
|
||||
- the freedom to adopt it to your own needs and to your own products.
|
||||
|
||||
You may do whatever you want with this software, but you can not take these
|
||||
freedoms away from it. These freedoms are granted to you by the GPL only on the
|
||||
condition that you never take them away or deny them to someone else as you
|
||||
adopt, modify and redistribute this software. And you must also guard these
|
||||
freedoms from anyone who may try to take them away.
|
||||
|
||||
Contribution
|
||||
------------
|
||||
|
||||
If you want to work on juci or if you are using juci yourself and make
|
||||
modifications to it, it is usually a good idea if you submit your modifications
|
||||
as patches. This can be done by using "git format-patch --stdout" and then
|
||||
submitting the patch to me by email or through the JUCI github page at
|
||||
https://github.com/mkschreder/juci.git.
|
||||
|
||||
For detailed instructions on how to submit patches see:
|
||||
[Submitting Patches](https://github.com/mkschreder/juci/blob/master/docs/submitting-patches.md)
|
||||
|
||||
If you make any significant patches to JUCI to accomodate your project needs,
|
||||
it is very good if you submit them upstream to main juci project because your
|
||||
changes are likely to become obsolete within a few months unless they are
|
||||
integrated into the main project.
|
||||
|
||||
Copyright Assignment
|
||||
--------------------
|
||||
|
||||
As a contributor to the JUCI project you remain as the holder of the copyright
|
||||
of your own contribution. Even if the copyright, under any circumstances, gets
|
||||
reassigned to someone else - you as the original owner of your contribution
|
||||
still retain all rights and benefits of a copyright holder to relicense and
|
||||
redistribute the code as your own. (note that GPL code that has once been
|
||||
released under GPL can not ever be made private in it's already released form.
|
||||
Only later versions can be made private - if you are the copyright holder.)
|
||||
Such a situation is however very unlikely to occur, unless someone decides to
|
||||
breach the GPL and do something stupid.
|
||||
If you want to contribute to this project, feel free to submit pull requests.
|
||||
|
||||
Good to know
|
||||
------------
|
||||
@ -489,19 +416,6 @@ JUCI documentation can definitely be improved. You can speed up this process by
|
||||
posting your questions on the issues board on juci github page
|
||||
(https://github.com/mkschreder/juci/issues).
|
||||
|
||||
About Me
|
||||
--------
|
||||
|
||||
I'm a freelance consultant and I love to develop software. I work best when I
|
||||
can freely apply my knowledge to fulfill customer needs and adopt free software
|
||||
for solving specific customer problems. I can accept work from anyone as long
|
||||
as it is compatible with my existing obligations and duties. I do not work
|
||||
exclusively for anyone - it does not motivate me and I find it detrimental to
|
||||
performance. I find that I achieve best results when I get to adopt my software
|
||||
to a wide variety of different situations which resonates very well with the
|
||||
freedoms of free software. If you feel that I can add value to your products
|
||||
you should definitely email me about it to mkschreder.uk@gmail.com.
|
||||
|
||||
License Notice
|
||||
--------------
|
||||
|
||||
|
||||
@ -1,25 +1,44 @@
|
||||
CORE OBJECTS
|
||||
============
|
||||
|
||||
The core system of juci is very small. In fact, it is there basically to provide a simple startup code and to bind all other parts together. JUCI is built almost entirely using angular.js and all components are tied together mostly through angular. The core codebase merely provides ways for juci to make RPC calls to the backend and manipulate configuration settings in UCI. The core is located in /juci/src/js/ folder of the source tree.
|
||||
The core system of juci is very small. In fact, it is there basically to
|
||||
provide a simple startup code and to bind all other parts together. JUCI is
|
||||
built almost entirely using angular.js and all components are tied together
|
||||
mostly through angular. The core codebase merely provides ways for juci to make
|
||||
RPC calls to the backend and manipulate configuration settings in UCI. The core
|
||||
is located in /juci/src/js/ folder of the source tree.
|
||||
|
||||
JUCI is built in such a way that almost every file that exists in juci environment overrides something or extends already existing objects with methods and properties. Usually this is done to angular by adding controllers, directives and factories. But it is also a standard way of extending other parts of the system.
|
||||
JUCI is built in such a way that almost every file that exists in juci
|
||||
environment overrides something or extends already existing objects with
|
||||
methods and properties. Usually this is done to angular by adding controllers,
|
||||
directives and factories. But it is also a standard way of extending other
|
||||
parts of the system.
|
||||
|
||||
# juci/src/js/app.js
|
||||
|
||||
This file takes care of registering angular.run(2) callbacks which will setup the angular application and configure default settings. All run() callbacks will run each time the application is loaded - and configure() callbacks will run before all run callbacks.
|
||||
This file takes care of registering angular.run(2) callbacks which will setup
|
||||
the angular application and configure default settings. All run() callbacks
|
||||
will run each time the application is loaded - and configure() callbacks will
|
||||
run before all run callbacks.
|
||||
|
||||
# juci/src/js/compat.js
|
||||
|
||||
This is the browser compatibility layer for JUCI. It implements methods like Object.assign and Array.find which may not be present in some browsers.
|
||||
This is the browser compatibility layer for JUCI. It implements methods like
|
||||
Object.assign and Array.find which may not be present in some browsers.
|
||||
|
||||
# juci/src/js/config.js
|
||||
|
||||
This file is actually quite old and needs to be rewriteen to be more platform independent - and in fact, most of the things that it does can be done in better ways. But the basic purpose of this subsystem is to load configuration for juci either from /etc/config/juci uci file or from config.json found in the www root folder.
|
||||
This file is actually quite old and needs to be rewriteen to be more platform
|
||||
independent - and in fact, most of the things that it does can be done in
|
||||
better ways. But the basic purpose of this subsystem is to load configuration
|
||||
for juci either from /etc/config/juci uci file or from config.json found in the
|
||||
www root folder.
|
||||
|
||||
# juci/src/js/juci.js
|
||||
|
||||
This is main juci library file that is supposed to initialize UCI and UBUS modules. This file supports being loaded standalone for initializing juci library and for running juci UBUS and UCI api inside for example node.js.
|
||||
This is main juci library file that is supposed to initialize UCI and UBUS
|
||||
modules. This file supports being loaded standalone for initializing juci
|
||||
library and for running juci UBUS and UCI api inside for example node.js.
|
||||
|
||||
# juci/src/js/localStorage.js
|
||||
|
||||
@ -35,17 +54,25 @@ This library provides interface to ubus RPC on the server.
|
||||
|
||||
# juci/src/js/theme.js
|
||||
|
||||
Theme manager in juci. This is actually no longer used, because loading a theme has become a little more complicated than just loading a css file. But this file is still left in the tree for now because it is used by theme picker control.
|
||||
Theme manager in juci. This is actually no longer used, because loading a theme
|
||||
has become a little more complicated than just loading a css file. But this
|
||||
file is still left in the tree for now because it is used by theme picker
|
||||
control.
|
||||
|
||||
# juci/src/js/timeout.js
|
||||
|
||||
Timeout system for implementing timeouts and intervals of limited lifespan that only live until next page is loaded.
|
||||
Timeout system for implementing timeouts and intervals of limited lifespan that
|
||||
only live until next page is loaded.
|
||||
|
||||
# juci/src/js/tr.js
|
||||
|
||||
JUCI language and translation system. This is really just a simple wrapper to make using gettext more convenient.
|
||||
JUCI language and translation system. This is really just a simple wrapper to
|
||||
make using gettext more convenient.
|
||||
|
||||
# juci/src/js/uci.js
|
||||
|
||||
The juci UCI subsystem. Together with juci RPC this system allows to easily handle uci data by providing a convenient getter/setter based interface to uci objects so that values can easily be set inside the browser and then sync-ed automatically to the server with only changed values being sent over the wire.
|
||||
The juci UCI subsystem. Together with juci RPC this system allows to easily
|
||||
handle uci data by providing a convenient getter/setter based interface to uci
|
||||
objects so that values can easily be set inside the browser and then sync-ed
|
||||
automatically to the server with only changed values being sent over the wire.
|
||||
|
||||
|
||||
@ -1,34 +0,0 @@
|
||||
The JUCI Story
|
||||
--------------
|
||||
|
||||
In April 2015 I came in as a consultant at Inteno in the middle of release
|
||||
cycle for next generation of Iopsys Open Source SDK for Inteno broadband
|
||||
routers. One of the things that fell on me is quickly adding new functionality
|
||||
to the existing webgui. I quickly realized that it was not feasible. The
|
||||
existing gui was written in lua and adding new pages was a bizarre journey of
|
||||
knocking out html code by calling lua functions. It was bizarre at best and it
|
||||
was not even Inteno's fault - they used a ready made solution and had on their
|
||||
todo list for years the task of improving it. It just never came to completion.
|
||||
|
||||
So I took on me the task of creating the new gui. In two months I made a
|
||||
working prototype to what was at the time called luci-express. It got that name
|
||||
from the fact that originally I was exploring the idea of using nodejs and
|
||||
express to build it - but then I instead settled for using angular.js and parts
|
||||
of luci2 (with most of the code from luci2 now removed, but backend such as
|
||||
rpcd was in fact created specifically for luci2 on openwrt and is still in use
|
||||
today).
|
||||
|
||||
The name luci-express was however not descriptive enough - especially since the
|
||||
"L" in luci stands for Lua and luci-express was basically writen in javascript.
|
||||
So I came up with a better name for it instead which came to be the acronym for
|
||||
Javascript Universal Configuration Interface - and that's how JUCI was born.
|
||||
Besides, everyone seemed to like it so JUCI became the name.
|
||||
|
||||
It took another six months to make juci a worthy contestant for being used in a
|
||||
production environment. Over time more people joined development and now we are
|
||||
a few people adding new things to JUCI. It proved to be quite useful and
|
||||
actually quite nice to work with. It was all made possible with initial support
|
||||
from Inteno and Iopsys and the examples of already working systems.
|
||||
|
||||
Contact: Martin K. Schröder <mkschreder.uk@gmail.com>
|
||||
Git: https://github.com/mkschreder/juci.git
|
||||
@ -1,7 +1,8 @@
|
||||
JUCI
|
||||
====
|
||||
|
||||
JUCI WebGUI is designed for building modern and dynamic web interfaces for embedded devices.
|
||||
JUCI WebGUI is designed for building modern and dynamic web interfaces for
|
||||
embedded devices.
|
||||
|
||||
* Project git: [https://github.com/mkschreder/juci](https://github.com/mkschreder/juci)
|
||||
* Official docs: [https://mkschreder.github.io/juci](https://mkschreder.github.io/juci)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
JUCI WIRELESS SUBSYSTEM
|
||||
=======================
|
||||
|
||||
TODO
|
||||
|
||||
METHODS
|
||||
-------
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user