Latest revision as of 01:59, 4 September 2023

Alpine Configuration Framework

The Alpine Configuration Framework (ACF) is a mvc-style application for configuring an Alpine Linux device. The primary focus is for a web interface - ACF's main goal is to be a light-weight MVC "webmin".

Why Haserl + Lua

Other competitors in the arena were Webmin, Ruby on Rails, PHP with templates.

A full webmin (Perl), RoR or PHP implementation each require several MB of installed code, and can have very slow startup times, especially when used in "cgi" mode. After evaluating many options, we found that Lua has the following advantages:

It is small (typically ~200KB of compiled code)
It compiles and runs much faster than PHP, Perl^{[Dead Link]} or Ruby
It provides a "normal" scripting language with features similar to PHP, perl, java, awk, etc.

Haserl + Lua provides a 'good enough' toolset to build a full-featured web application.

Why ACF is MVC

The MVC design pattern is used to separate presentation information from control logic. By MVC we mean:

Model - code that reads / writes a config file, starts / stops daemons, or does other work modifying the router.
View - code that formats data for output
Controller - code that glues the two together

Note the lack of words like: HTML, XML, OO, AJAX, etc. The purpose of ACF's MVC is simply to separate the configuration logic from the presentation of the output.

The flow of a single transaction is:

start -> execute requested function in controller, optionally reading/writing a file using functions in the model -> execute the view to format the output -> end

Every transaction follows this pattern. For ACF developers, the focus should be on getting a model that does a proper job of abstracting the config file into useable entities and then building a controller that presents useable "actions" based on the model. The presentation layer should be last on the priority list.

Of course, as with all MVC designs, the ACF MVC design is not quite 'pure' MVC and has evolved over time. Most of the controller functionality is handled by the framework code. The framework code will also automatically generate views for HTML, JSON, and a few other viewtypes if no view is defined. Also, many model functions are implemented in helper libraries. We have attempted to make it as easy as possible to develop new ACF modules.

For good background information on what ACF attempts to do, please see Terence Parr's paper "Enforcing Strict Model-View Separation in Template Engines" at https://www.cs.usfcs.edu.

Starting ACF

Installing ACF is really simple. Just type this in your terminal and follow the instructions to setup ACF:

setup-acf

(This script will install mini-httpd, create a certificate, starts mini-httpd in HTTPS mode and installs some basic acf-packages.)

To view ACF, simply browse to your machine https://<hostname>/

ACF Developer's Guides

mvc.lua reference - mvc.lua is the core of ACF
mvc.lua example - build a simple (command-line) application
acf www-controller reference - ACF www application functions
acf www-controller example - webify the above examples
ACF how to write - Step by step howto for writing ACF modules
ACF core principles - Things that are standard across the application
LPOSIX - Documentation for the Lua Posix functions
ACF Libraries - Document the libraries and common functions
Writing ACF Views - Guide for writing a view
Writing ACF Controllers - Guide for writing a controller
Writing ACF Models - Guide for writing a model

ACF Layout

ACF has support for multiple skins.
Only a few skins are available. Feel free to contribute in programming css-stylesheets for ACF.

How to contribute

First, download ACF using git or installing available ACF modules using 'apk add'.
Easiest is if you download the latest Alpine Linux ISO, boot a box from the ISO and then run 'setup-alpine' and 'setup-acf'. That way you get a running environment fast and easy!
Some example skins are available:

/usr/share/acf/www/skins/alps/
/usr/share/acf/www/skins/cloud/
/usr/share/acf/www/skins/ice/
/usr/share/acf/www/skins/snow/
/usr/share/acf/www/skins/wik/

Make a new skin folder.

mkdir -p /etc/acf/skins/myskin

Create a css file called as the folder.

touch /etc/acf/skins/myskin/myskin.css

Now you can start editing your myskin.css.
If you have ACF running on the computer, you can browse to https://<hostname>/cgi-bin/acf/acf-util/skins/read and switch to your new skin (called myskin) and see the results of your changes.

Pack your myskin folder, containing your css file (and images, if there are any).
Send this patch to acf@lists.alpinelinux.org (Note: Don't forget to subscribe before sending your patch)

ACF Packages

Look at ACF packages to see available ACF modules and their status.

@@ Line 1: / Line 1: @@
-== Documentation for the Alpine Configuration Framework ==
+= Alpine Configuration Framework  =
-The Alpine Configuration Framework (ACF) is a mvc-style application for configuring an Alpine device.  The primary focus is for a web interface - ACF's main goal is to be a light-weight MVC "webmin".
+The Alpine Configuration Framework (ACF) is a mvc-style application for configuring an Alpine Linux device. The primary focus is for a web interface - ACF's main goal is to be a light-weight MVC "webmin".
-==== Why Haserl + Lua was chosen over Webmin, Ruby on Rails, or PHP with templates ====
+== Why Haserl + Lua  ==
-A full webmin (Perl), RoR or PHP implementation each require several MB of installed code, and can have very slow startup times, especially when used in "cgi" mode.  After evaluating many options, we found that [[http://www.lua.org Lua]] has the following advantages:
+Other competitors in the arena were Webmin, Ruby on Rails, PHP with templates.
-* It is small (typically ~200KB of compiled code)
+A full webmin (Perl), RoR or PHP implementation each require several MB of installed code, and can have very slow startup times, especially when used in "cgi" mode. After evaluating many options, we found that [https://www.lua.org Lua] has the following advantages:
-* It compiles and runs much faster than PHP or Perl
-* It provides a "normal" scripting language with features similar to PHP, perl, java, awk, etc.
+*It is small (typically ~200KB of compiled code)
+*It compiles and runs much faster than [https://web.archive.org/web/20100707143932/http://shootout.alioth.debian.org/gp4/benchmark.php?test=all&lang=lua&lang2=php PHP], [http://shootout.alioth.debian.org/gp4/benchmark.php?test=all&lang=lua&lang2=perl Perl]{{dead link}} or [https://web.archive.org/web/20100313062645/http://shootout.alioth.debian.org/gp4/benchmark.php?test=all&lang=lua&lang2=ruby Ruby]
+*It provides a "normal" scripting language with [https://en.wikipedia.org/wiki/Lua_(programming_language)#Features features] similar to PHP, perl, java, [[awk]], etc.
 Haserl + Lua provides a 'good enough' toolset to build a full-featured web application.
-==== Why ACF is MVC ====
+== Why ACF is MVC  ==
+The MVC design pattern is used to separate presentation information from control logic. By MVC we mean:
+*'''Model''' - code that reads / writes a config file, starts / stops daemons, or does other work modifying the router.
+*'''View''' - code that formats data for output
+*'''Controller''' - code that glues the two together
+Note the lack of words like: HTML, XML, OO, AJAX, etc. The purpose of ACF's MVC is simply to separate the configuration logic from the presentation of the output.
+The flow of a single transaction is:
+start -&gt; execute requested function in '''controller''', optionally reading/writing a file using functions in the '''model''' -&gt; execute the '''view''' to format the output -&gt; end
+''Every'' transaction follows this pattern. For ACF developers, the focus should be on getting a model that does a proper job of abstracting the config file into useable entities and then building a controller that presents useable "actions" based on the model. The presentation layer should be last on the priority list.
+Of course, as with all MVC designs, the ACF MVC design is not quite 'pure' MVC and has evolved over time. Most of the '''controller''' functionality is handled by the framework code. The framework code will also automatically generate views for HTML, JSON, and a few other viewtypes if no '''view''' is defined. Also, many '''model''' functions are implemented in helper libraries. We have attempted to make it as easy as possible to develop new ACF modules.
+For good background information on what ACF attempts to do, please see Terence Parr's paper "Enforcing Strict Model-View Separation in Template Engines" at [https://www.cs.usfca.edu/~parrt/papers/mvc.templates.pdf https://www.cs.usfcs.edu].
+= Starting ACF  =
+Installing ACF is really simple. Just type this in your terminal and follow the instructions to setup ACF:
+{{cmd|setup-acf}}
+''(This script will install mini-httpd, create a certificate, starts mini-httpd in HTTPS mode and installs some basic acf-packages.)''<BR>
+To view ACF, simply browse to your machine https://&lt;hostname&gt;/
+See also [[Managing ACF|Managing Your ACF Installation]]
+{{tip|Alternately, you can manually install ACF and your web server. The two critical ACF packages are acf-core and acf-alpine-baselayout. The ACF packages will install to /usr/share/acf. You can configure your web server to give access to /usr/share/acf/www and run cgi scripts from /usr/share/acf/www/cgi-bin, and you should be able to view ACF.}}
+= ACF Developer's Guides  =
+#[[ACF mvc.lua reference|mvc.lua reference]] - mvc.lua is the core of ACF
+#[[ACF mvc.lua example|mvc.lua example]] - build a simple (command-line) application
+#[[ACF acf www-controller.lua reference|acf www-controller reference]] - ACF www application functions
+#[[ACF acf www example|acf www-controller example]] - webify the above examples
+#[[ACF how to write]] - Step by step howto for writing ACF modules
+#[[ACF core principles]] - Things that are standard across the application
+#[[LPOSIX]] - Documentation for the Lua Posix functions
+#[[ACF Libraries]] - Document the libraries and common functions
+#[[Writing ACF Views]] - Guide for writing a view
+#[[Writing ACF Controllers]] - Guide for writing a controller
+#[[Writing ACF Models]] - Guide for writing a model
+== Other useful links  ==
+#[https://www.lua.org/manual/5.1/ Lua 5.1 Reference Manual]
+#[https://www.lua.org/pil/ Programming in Lua (first edition)]
+#[[Managing ACF]]
+= ACF Layout  =
+ACF has support for multiple skins.<br>Only a few skins are available. Feel free to contribute in programming css-stylesheets for ACF.
+== How to contribute  ==
+First, download ACF using git or installing available ACF modules using 'apk add'.<br>Easiest is if you download the latest Alpine Linux ISO, boot a box from the ISO and then run 'setup-alpine' and 'setup-acf'. That way you get a running environment fast and easy!<br>Some example skins are available:
+*/usr/share/acf/www/skins/alps/
+*/usr/share/acf/www/skins/cloud/
+*/usr/share/acf/www/skins/ice/
+*/usr/share/acf/www/skins/snow/
+*/usr/share/acf/www/skins/wik/
-The MVC design pattern is used to separate presentation information from control logic.  By MVC we mean:
+Make a new skin folder.
-* '''Model''' - code that reads / writes a config file, starts / stops daemons, or does other work modifying the router.
+ mkdir -p /etc/acf/skins/myskin
-* '''View''' - code that formats data for output
-* '''Controller''' - code that glues the two together
-Note the lack of words like: HTML, XML, OO, AJAX, etc.  The purpose of ACF's MVC is simply to separate the configuration logic from the presentation of the output.
+Create a css file called as the folder.
-The flow of a single transaction is:
+ touch /etc/acf/skins/myskin/myskin.css
-start ->
+Now you can start editing your myskin.css.<br>If you have ACF running on the computer, you can browse to https://&lt;hostname&gt;/cgi-bin/acf/acf-util/skins/read and switch to your new skin (called myskin) and see the results of your changes.
-execute requested function in '''controller''',
-optionally reading/writing a file using functions in the '''model''' ->
-execute the '''view''' to format the output ->
-end
-''Every'' transaction follows this pattern.  For ACF developers, the focus should be on getting a model that does a proper job of abstracting the config file into useable entities and then building a controller that presents useable "actions" based on the model.   The presentation layer should be last on the priority list.
+Pack your myskin folder, containing your css file (and images, if there are any).<br>Send this patch to acf@lists.alpinelinux.org ''('''Note:''' Don't forget to [[Alpine_Linux:Mailing_lists|subscribe]] before sending your patch)''
-=== ACF Developer's Guides ===
+= ACF Packages  =
-* [[Introduction to the mvc.lua core module]]  (The lua module that is at the core of ACF.)
+Look at [[ACF packages]] to see available ACF modules and their status.
-* [[ACF core principles]] (Things that are standard across the application)
+[[Category:ACF]] [[Category:Lua]]