tazpanel annotate README @ rev 82

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