SliTaz Repositories

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.html	Fri May 04 13:00:43 2012 +0300
     1.3 @@ -0,0 +1,90 @@
     1.4 +<h2>SliTaz Web Control Panel</h2>
     1.5 +
     1.6 +<p>Tazpanel is the SliTaz Control Panel, a web interface which lets you manage the
     1.7 +full system in a radically simple way. The output xHTML code is valid xHTML 5
     1.8 +and all theming is done with standard CSS 3. TazPanel is published under a
     1.9 +BSD License.</p>
    1.10 +
    1.11 +
    1.12 +<h3>Use it!</h3>
    1.13 +
    1.14 +<p>You can clone the tazpanel repo into /var/www/tazpanel and work on this
    1.15 +copy or clone it somewhere else and 'make install'. After, add tazpanel to
    1.16 +your /etc/hosts, type './tazpanel start' to start the server and go to the
    1.17 +URL: http://tazpanel:82. Panel user and password are defined in the 
    1.18 +httpd.conf and default is root:root</p>
    1.19 +
    1.20 +
    1.21 +<h3>i18n</h3>
    1.22 +
    1.23 +<p>TazPanel has been coded from the beginning with gettext support. Please
    1.24 +forget 'echo' and use gettext, but remember that gettext "" is equivalent
    1.25 +to echo -n. All scripts use the same TEXTDOMAIN and the same pot files, and 
    1.26 +all translations go in the po/ folder. To start a new translation please
    1.27 +use msginit from the pot file directory. Example for French/France
    1.28 +locale (fr_FR):</p>
    1.29 +
    1.30 +<pre>$ msginit -l fr_FR -o fr.po -i tazpanel.pot</pre>
    1.31 +
    1.32 +<p>To update all translations from a newly updated pot file:</p>
    1.33 +
    1.34 +<pre>$ make msgmerge</pre>
    1.35 +
    1.36 +
    1.37 +<h3>User interface</h3>
    1.38 +
    1.39 +<p>If you develop an official SliTaz GUI for TazPanel, please follow the default 
    1.40 +style. If you need more CSS markup and you are not a coder, please ask an 
    1.41 +official developer for the best way to implement your idea. TazPanel is fully 
    1.42 +themable and more than one theme can be installed, this will allow us to make 
    1.43 +packages in a TazPanel style! All the GUI is done with xHTML 5 and CSS 3, some
    1.44 +javascript can be used, but with precautions... one more time, it's better
    1.45 +to check with a main contributor before adding too much stuff, the goal is,
    1.46 +as for all the SliTaz projects: KISS</p>
    1.47 +
    1.48 +
    1.49 +<h3>CGI template and files</h3>
    1.50 +
    1.51 +<p>To start or test a new function with TazPanel you will find a file in
    1.52 +utils/template.cgi that needs to be in the $PANEL root to work, all TazPanel
    1.53 +CGI scripts are in that location. If you think your code is too big to fit
    1.54 +in another script you can eventually create a new CGI page and update all
    1.55 +links, but please to talk to the AUTHORS beforehand.</p>
    1.56 +
    1.57 +<dl>
    1.58 +	<dt>index.cgi</dt>
    1.59 +		<dd>Main Tazpanel CGI script</dd>
    1.60 +	<dt>boot.cgi</dt>
    1.61 +		<dd>All what happens before login</dd>
    1.62 +	<dt>network.cgi</dt>
    1.63 +		<dd>All related stuff to networking (eth, wifi, services)</dd>
    1.64 +	<dt>pkgs.cgi</dt>
    1.65 +		<dd>Tazpkg packages CGI interface</dd>
    1.66 +	<dt>settings.cgi</dt>
    1.67 +		<dd>System settings and services such as time, users accounts,
    1.68 +		locales or daemons management</dd>
    1.69 +	<dt>live.cgi</dt>
    1.70 +		<dd>All tools related to Live systems (CD, USB, Frugal)</dd>
    1.71 +	<dt>hardware.cgi</dt>
    1.72 +		<dd>Devices drivers, firmware, printing</dd>
    1.73 +	<dt>help.cgi</dt>
    1.74 +		<dd>Cat the html doc and this README file</dd>
    1.75 +</ul>
    1.76 +
    1.77 +<p>For common functions have a look to lib/libtazpanel, you may found functions
    1.78 +you need already coded such as a xhtml_header to get the style header.html
    1.79 +in your CGI script. For the loading message you can use loading_msg. When
    1.80 +cat is used: `gettext "Text to translate"`</p>
    1.81 +
    1.82 +
    1.83 +<h3>Web server</h3>
    1.84 +
    1.85 +<p>Tazpanel can run with the Busybox httpd applet or LightTPD and probably Apache.
    1.86 +Start the webserver with a custom config to listen only on a local port for
    1.87 +security reasons since we run as root to perform system actions, example:</p>
    1.88 +
    1.89 +<pre># httpd -p 82 u root -c /etc/slitaz/httpd.conf</pre>
    1.90 +
    1.91 +<p>Or use a tazpanel cmdline:</p>
    1.92 +
    1.93 +<pre># ./tazpanel start</pre>