tinycm view README @ rev 9

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