README.html

<section>
	<header>SliTaz Web Control Panel</header>
	<div>
		<p>TazPanel is the SliTaz Control Panel, a web interface which lets you manage the full system in a radically simple way. The output xHTML code is valid HTML 5 and all theming is done with standard CSS 3. TazPanel is published under a BSD License.</p>


		<h3>Use it!</h3>

		<p>You can clone the tazpanel repo into <tt>/var/www/tazpanel</tt> and work on this copy or clone it somewhere else and <tt>'make install'</tt>. After, add <tt>tazpanel</tt> to your <tt>/etc/hosts</tt>, type <tt>'./tazpanel start'</tt> to start the server and go to the URL: <tt>http://tazpanel:82</tt>. Panel user and password are defined in the <tt>httpd.conf</tt> and default is <tt>root:root</tt></p>


		<h3>i18n</h3>

		<p>TazPanel has been coded from the beginning with gettext support. Please forget <tt>'echo'</tt> and use <tt>gettext</tt>, but remember that <tt>gettext ""</tt> is equivalent to <tt>echo -n</tt>. All scripts use the same <tt>TEXTDOMAIN</tt> and the same pot files, and all translations go in the <tt>po/</tt> folder. To start a new translation please use <tt>msginit</tt> from the pot file directory. Example for French/France locale (fr_FR):</p>
		<pre>$ msginit -l fr_FR -o fr.po -i tazpanel.pot</pre>
		<p>To update all translations from a newly updated pot file:</p>
		<pre>$ make msgmerge</pre>


		<h3>User interface</h3>

		<p>If you develop an official SliTaz GUI for TazPanel, please follow the default style. If you need more CSS markup and you are not a coder, please ask an official developer for the best way to implement your idea. TazPanel is fully themable and more than one theme can be installed, this will allow us to make packages in a TazPanel style! All the GUI is done with HTML 5 and CSS 3; some javascript can be used, but with precautions… one more time, it's better to check with a main contributor before adding too much stuff; the goal is, as for all the SliTaz projects: KISS</p>


		<h3>CGI template and files</h3>

		<p>To start or test a new function with TazPanel you will find a file in <tt>utils/template.cgi</tt> that needs to be in the <tt>$PANEL</tt> root to work, all TazPanel CGI scripts are in that location. If you think your code is too big to fit in another script you can eventually create a new CGI page and update all links, but please to talk to the AUTHORS beforehand.</p>
		<dl>
			<dt>index.cgi</dt>
				<dd>Main Tazpanel CGI script</dd>
			<dt>boot.cgi</dt>
				<dd>All what happens before login</dd>
			<dt>network.cgi</dt>
				<dd>All related stuff to networking (Ethernet, Wi-Fi, services)</dd>
			<dt>pkgs.cgi</dt>
				<dd>Tazpkg packages CGI interface</dd>
			<dt>settings.cgi</dt>
				<dd>System settings and services such as time, users accounts, locales or daemons management</dd>
			<dt>live.cgi</dt>
				<dd>All tools related to Live systems (CD, USB, Frugal)</dd>
			<dt>hardware.cgi</dt>
				<dd>Devices drivers, firmware, printing</dd>
			<dt>help.cgi</dt>
				<dd>Cat the html doc and this README file</dd>
		</dl>
		<p>For common functions have a look at <tt>lib/libtazpanel</tt>, where you may find functions you need already coded such as a <tt>xhtml_header</tt> to get the style <tt>header.html</tt> in your CGI script. For the loading message you can use <tt>loading_msg</tt>. When cat is used:</p>
		<pre>$(gettext "Text to translate")</pre>


		<h3>Web server</h3>

		<p>TazPanel can run with the Busybox httpd applet or LightTPD and probably Apache. Start the webserver with a custom config to listen only on a local port for security reasons since we run as root to perform system actions, example:</p>
		<pre># httpd -p 82 u root -c /etc/slitaz/httpd.conf</pre>
		<p>Or use a tazpanel cmdline:</p>
		<pre># ./tazpanel start</pre>

	</div>
</section>