tazpanel view README @ rev 204
Edit docs and README
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Sun Aug 14 00:12:36 2011 +0100 (2011-08-14) |
| parents | f054918e093c |
| children | 831e551d12d4 |
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. TazPanel is published under a
8 BSD License.
11 Use it!
12 ------
13 You can clone the tazpanel repo into /var/www/tazpanel and work on this
14 copy or clone it somewhere else and 'make install'. After, add tazpanel to
15 your /etc/hosts, type './tazpanel start' to start the server and go to the
16 URL: http://tazpanel:82. Panel user and password are defined in the
17 httpd.conf and default is root:root
20 i18n
21 ----
22 TazPanel has been coded from the beginning with gettext support. Please
23 forget 'echo' and use gettext, but remember that gettext "" is equivalent
24 to echo -n. All scripts use the same TEXTDOMAIN and the same pot files, and
25 all translations go in the po/ folder. To start a new translation please
26 use msginit from the pot file directory. Example for French/France
27 locale (fr_FR):
29 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
31 To update all translations from a newly updated pot file:
33 $ make msgmerge
36 User interface
37 --------------
38 If you develop an official SliTaz GUI for TazPanel, please follow the default
39 style. If you need more CSS markup and you are not a coder, please ask an
40 official developer for the best way to implement your idea. TazPanel is fully
41 themable and more than one theme can be installed, this will allow us to make
42 packages in a TazPanel style! All the GUI is done with xHTML 5 and CSS 3, some
43 javascript can be used, but with precautions... one more time, it's better
44 to check with a main contributor before adding too much stuff, the goal is,
45 as for all the SliTaz projects: KISS
48 CGI template and files
49 ----------------------
50 To start or test a new function with TazPanel you will find a file in
51 utils/template.cgi that needs to be in the $PANEL root to work, all TazPanel
52 CGI scripts are in that location. If you think your code is too big to fit
53 in another script you can eventually create a new CGI page and update all
54 links, but please to talk to the AUTHORS beforehand.
56 * index.cgi Main Tazpanel CGI script
57 * boot.cgi All what happens before login
58 * network.cgi All related stuff to networking (eth, wifi, services)
59 * pkgs.cgi Tazpkg packages CGI interface
60 * settings.cgi System settings and services such as time, users
61 accounts, locales or daemons management
62 * live.cgi All tools related to Live systems (CD, USB, Frugal)
63 * hardware.cgi Devices drivers, firmware, printing
64 * help.cgi Cat the html doc and this README file
66 For common functions have a look to lib/libtazpanel, you may found functions
67 you need already coded such as a xhtml_header to get the style header.html
68 in your CGI script. For the loading message you can use loading_msg. When
69 cat is used: `gettext "Text to translate"`
72 Web server
73 ----------
74 Tazpanel can run with the Busybox httpd applet or LightTPD and probably Apache.
75 Start the webserver with a custom config to listen only on a local port for
76 security reasons since we run as root to perform system actions, example:
78 # httpd -p 82 u root -c /etc/slitaz/httpd.conf
80 Or use a tazpanel cmdline:
82 # ./tazpanel start
85 ================================================================================