tinycm rev 0

Initial commit with README
author Christophe Lincoln <pankso@slitaz.org>
date Tue Apr 10 21:38:26 2012 +0200 (2012-04-10)
parents
children b0892064b66b
files README
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue Apr 10 21:38:26 2012 +0200
     1.3 @@ -0,0 +1,68 @@
     1.4 +TinyCM - A micro CGI/SHell Content Manager!
     1.5 +================================================================================
     1.6 +
     1.7 +
     1.8 +	* CGI/Shell powered, small Wiki syntaxe and HTML JS editor helper
     1.9 +	* Tiny, fast, elegent and easy to install and customize
    1.10 +	* No database, flat file storage with diff and log
    1.11 +	* Plugins support for any kind of functions such as a blog
    1.12 +	* Help file with formating rules, macro and HTML example code
    1.13 +	* Gettexte support and languages support for documents
    1.14 +
    1.15 +
    1.16 +Installation
    1.17 +------------
    1.18 +You must first get TinyCM source code via a tarball on SliTaz mirrors or Hg 
    1.19 +repository. You can extract or clone the CM under a web server directory,
    1.20 +for security reason the config file have a .cgi extension and users data are
    1.21 +stored outsite the web server in the directory /var/lib/slitaz. The user
    1.22 +files paths can be changed via the configuration file.
    1.23 +
    1.24 +When you have your copy of TinyCM you can then install web interface under a
    1.25 +CGI/SHell enabled web server such as Busybox HTTPd, LightTPD or Apache. Gettext
    1.26 +must be installed for localisation support. So, let download Content Manager:
    1.27 +
    1.28 +	$ wget http://mirror.slitaz.org/sources/tinycm/tinycm-VERSION.tar.gz
    1.29 +	$ tar xzf tinycm-VERSION.tar.gz
    1.30 +	
    1.31 +Or clone the Mercurial repo:
    1.32 +	
    1.33 +	$ hg clone http://hg.slitaz.org/tinycm
    1.34 +
    1.35 +
    1.36 +Change directory to the CM, check and edit the configuration file config.cgi
    1.37 +and use make to install:
    1.38 +
    1.39 +	$ cd tinycm*
    1.40 +	$ editor config.cgi
    1.41 +	$ make install
    1.42 +
    1.43 +
    1.44 +Standalone Server
    1.45 +-----------------
    1.46 +On SliTaz you can install a copy of TinyCM somewhere under you $HOME directory
    1.47 +and start the stand alone web server powered by Busybox HTTPd applet. This also
    1.48 +help to debug TazCM since error messages are displayed in the terminal. To
    1.49 +start the server, cd to TinyCM dir and execute:
    1.50 +
    1.51 +$ ./tinycm serv
    1.52 +
    1.53 +
    1.54 +Mercurial integration
    1.55 +---------------------
    1.56 +TinyCM can smothily be integrated with Mercurial, each new document and edit
    1.57 +will be committed. You must first edit you config.cgi configuration to 
    1.58 +enable Hg with HG="yes" then login to your TinyCM follow the link to init the
    1.59 +repo or do it manually: cd content && hg init && hg add && hg commit -m "Message"
    1.60 +
    1.61 +Then all content will be under Hg and people can commit as usual, to make sure
    1.62 +we use the last files on the web interface we use a Hook to update the repo on
    1.63 +each commit. To have the mercurial web interface for the repo you can setup
    1.64 +a vhost, TinyCM provide a small web interface to display Hg log but it can
    1.65 +be extented via a plugin. Hook for $content/.hg/hgrc:
    1.66 +
    1.67 +[hooks]
    1.68 +incoming = hg update
    1.69 +
    1.70 +
    1.71 +================================================================================