tazpanel annotate README @ rev 211

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