tazpanel view README @ rev 44

Add a loading mechanism for page that take long to be generated
author Christophe Lincoln <pankso@slitaz.org>
date Fri Apr 08 01:17:37 2011 +0200 (2011-04-08)
parents 1a80f769f6e1
children 56d55a9dcc9c
line source
1 SliTaz Web Control Panel
2 ================================================================================
5 Tazpanel is the SliTaz Control Panel, a web interface who let you manage the
6 full system in a redically simple way. The output xHTML code is valid xHTML 5
7 and all theming is done with standard CSS 3.
10 Use it!
11 ------
12 You can clone the tazpanel repo into /var/www/tazpanel and work on this
13 copy or clone it someweher esle and 'make install'. After, add tazpanel to
14 your /etc/hosts, type './tazpanel start' to start the server and go to the
15 URL: http://tazpanel:8090
18 i18n
19 ----
20 TazPanel have been coded from the beginning with gettext support. Please
21 forget 'echo' and use gettext, but remember that gettext "" is equivalent
22 to echo -n. All script use the same TEXTDOMAIN and the same pot files, all
23 translations goes in the po/ folder. To start a new translation please
24 use msginit from the pot file directory. Example for French/France
25 locale (fr_FR):
27 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
29 To update all translations from a newly updated the pot file:
31 $ make msgmerge
34 User interface
35 --------------
36 If you develope an official SliTaz GUI for TazPanel, please follow the style.
37 If you need more CSS markup and you not a coder, please ask an official
38 developer the better way to implement your idea. TazPanel is fully themable
39 and more than one theme can be installed, this will let us make packages
40 for TazPanel style! All the GUI is done with xHTML 5 and CSS 3, some
41 javascript can be used, but with precaution... one more time, it's better
42 to check with a main contributor before adding to much stuff, the goal is,
43 as for the all SliTaz project: KISS
46 CGI template and files
47 ----------------------
48 To start or test new function with TazPanel you will find a a file in
49 utils/template.cgi that need to be in the $PANEL root to work, all TazPanel
50 CGI scripts are in that location. If you think your code is too big to fit
51 in an other script you can eventually creat a new CGI page and update all
52 links, but please to talk to the AUTHORS before.
54 * index.cgi Main Tazpanel CGI script (some stuff may be splited
55 into users.cgi, boot.cgi, etc if too big or slow)
56 * network.cgi All related stuff to networking (eth, wifi, servives)
57 * pkgs.cgi Tazpkg packages CGI interface
58 * settings.cgi System settings such as time, users accounts, locales
59 * live.cgi All tools related to Live systems (CD, USB, Frugal)
61 For common function have a look to lib/libtazpanel you may founf functions
62 yoou need already coded such as xhtml_header to get the style header.html
63 in you CGI script. For the loading message you can use loading_msg
65 Web server
66 ----------
67 Tazpanel can run with Busybox httpd applet or LightTPD an propably Apache.
68 Start the webserver with custom config to listen only on local port for
69 security reason since we run as root to perform system actions, example:
71 # httpd -p 8090 u root -c /etc/slitaz/httpd.conf
73 Or use tazpanel cmdline:
75 # ./tazpanel start
78 Quick notes
79 -----------
81 Panel password is defined in httpd.conf
82 When cat is used: `gettext "Text to translate"`
83 Devel can run the web server with root in the src tree