tazpanel view README @ rev 52

Tiny edits and make pot
author Paul Issott <paul@slitaz.org>
date Sun Apr 10 11:23:06 2011 +0000 (2011-04-10)
parents cf15cb2ff715
children a797e9424727
line source
1 SliTaz Web Control Panel
2 ================================================================================
5 Tazpanel is the SliTaz Control Panel, a web interface which lets you manage the
6 full system in a radically 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 somewhere else 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. Panel user and password is defined in httpd.conf
16 and default is root:root
19 i18n
20 ----
21 TazPanel has been coded from the beginning with gettext support. Please
22 forget 'echo' and use gettext, but remember that gettext "" is equivalent
23 to echo -n. All scripts use the same TEXTDOMAIN and the same pot files, all
24 translations go in the po/ folder. To start a new translation please
25 use msginit from the pot file directory. Example for French/France
26 locale (fr_FR):
28 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
30 To update all translations from a newly updated the pot file:
32 $ make msgmerge
35 User interface
36 --------------
37 If you develop an official SliTaz GUI for TazPanel, please follow the style.
38 If you need more CSS markup and you are not a coder, please ask an official
39 developer for the best way to implement your idea. TazPanel is fully themable
40 and more than one theme can be installed, this will let us make packages
41 in a TazPanel style! All the GUI is done with xHTML 5 and CSS 3, some
42 javascript can be used, but with precautions... one more time, it's better
43 to check with a main contributor before adding too much stuff, the goal is,
44 as for the all SliTaz projects: KISS
47 CGI template and files
48 ----------------------
49 To start or test new function with TazPanel you will find a a file in
50 utils/template.cgi that needs to be in the $PANEL root to work, all TazPanel
51 CGI scripts are in that location. If you think your code is too big to fit
52 in another script you can eventually create a new CGI page and update all
53 links, but please to talk to the AUTHORS before.
55 * index.cgi Main Tazpanel CGI script (some stuff may be split
56 into users.cgi, boot.cgi, etc if too big or slow)
57 * network.cgi All related stuff to networking (eth, wifi, services)
58 * pkgs.cgi Tazpkg packages CGI interface
59 * system.cgi System settings and services such as time, users
60 accounts, locales or daemons management
61 * live.cgi All tools related to Live systems (CD, USB, Frugal)
62 * hardware.cgi Devices drivers, firmware, printing
64 For common functions have a look to lib/libtazpanel, you may found functions
65 you need already coded such as xhtml_header to get the style header.html
66 in your CGI script. For the loading message you can use loading_msg. When
67 cat is used: `gettext "Text to translate"`
70 Web server
71 ----------
72 Tazpanel can run with Busybox httpd applet or LightTPD and probably Apache.
73 Start the webserver with a custom config to listen only on a local port for
74 security reasons since we run as root to perform system actions, example:
76 # httpd -p 8090 u root -c /etc/slitaz/httpd.conf
78 Or use tazpanel cmdline:
80 # ./tazpanel start
83 ================================================================================