tinycm annotate README @ rev 12

Misc small fixes
author Christophe Lincoln <pankso@slitaz.org>
date Sat Jan 04 00:59:43 2014 +0100 (2014-01-04)
parents 9d0f7be12384
children 93e27f9ededd
rev   line source
pankso@0 1 TinyCM - A micro CGI/SHell Content Manager!
pankso@0 2 ================================================================================
pankso@0 3
pankso@0 4
paul@8 5 * CGI/Shell powered, small Wiki syntax and HTML JS editor helper
pankso@0 6 * Tiny, fast, elegent and easy to install and customize
pankso@0 7 * No database, flat file storage with diff and log
pankso@0 8 * Plugins support for any kind of functions such as a blog
pankso@0 9 * Help file with formating rules, macro and HTML example code
paul@8 10 * Gettext support and languages support for documents
pankso@0 11
pankso@0 12
pankso@0 13 Installation
pankso@0 14 ------------
pankso@0 15 You must first get TinyCM source code via a tarball on SliTaz mirrors or Hg
pankso@0 16 repository. You can extract or clone the CM under a web server directory,
paul@8 17 for security reasons the config file has a .cgi extension and users data are
paul@8 18 stored outside the web server in the directory /var/lib/slitaz. The user
pankso@0 19 files paths can be changed via the configuration file.
pankso@0 20
paul@8 21 When you have your copy of TinyCM you can then install a web interface under a
pankso@0 22 CGI/SHell enabled web server such as Busybox HTTPd, LightTPD or Apache. Gettext
paul@8 23 must be installed for localisation support. So, let's download the Content Manager:
pankso@0 24
pankso@0 25 $ wget http://mirror.slitaz.org/sources/tinycm/tinycm-VERSION.tar.gz
pankso@0 26 $ tar xzf tinycm-VERSION.tar.gz
pankso@0 27
pankso@0 28 Or clone the Mercurial repo:
pankso@0 29
pankso@0 30 $ hg clone http://hg.slitaz.org/tinycm
pankso@0 31
pankso@0 32
paul@8 33 Change directory to the CM, check and edit the configuration file config.cgi,
pankso@0 34 and use make to install:
pankso@0 35
pankso@0 36 $ cd tinycm*
pankso@0 37 $ editor config.cgi
pankso@0 38 $ make install
pankso@0 39
pankso@0 40
pankso@0 41 Standalone Server
pankso@0 42 -----------------
paul@8 43 On SliTaz you can install a copy of TinyCM anywhere under your $HOME directory
pankso@0 44 and start the stand alone web server powered by Busybox HTTPd applet. This also
paul@8 45 helps to debug TazCM since error messages are displayed in the terminal. To
pankso@0 46 start the server, cd to TinyCM dir and execute:
pankso@0 47
pankso@12 48 $ ./tools/serv.sh
pankso@0 49
pankso@0 50
pankso@0 51 Mercurial integration
pankso@0 52 ---------------------
paul@8 53 TinyCM can be integrated smoothly with Mercurial, each new document and edit
pankso@0 54 will be committed. You must first edit you config.cgi configuration to
paul@8 55 enable Hg with HG="yes" then login to your TinyCM, follow the link to init the
pankso@0 56 repo or do it manually: cd content && hg init && hg add && hg commit -m "Message"
pankso@0 57
paul@8 58 Then all content will be under Hg and people can commit as usual. To make sure
paul@8 59 we use the latest files on the web interface we use a Hook to update the repo on
pankso@0 60 each commit. To have the mercurial web interface for the repo you can setup
paul@8 61 a vhost, TinyCM provides a small web interface to display a Hg log but it can
pankso@0 62 be extented via a plugin. Hook for $content/.hg/hgrc:
pankso@0 63
pankso@0 64 [hooks]
pankso@0 65 incoming = hg update
pankso@0 66
pankso@0 67
pankso@0 68 ================================================================================