changelog shortlog tags branches changeset files revisions annotate raw help

Mercurial > hg > werc / README

changeset 640: e224f4300c6d
parent: 81ad57a45a3b
child: fce7c8747d57
author: Uriel <uriel@berlinblue.org>
date: Fri, 11 Jun 2010 06:41:18 +0200
permissions: -rw-r--r--
description: Added tag LATEST-RELEASE for changeset 3da783326101
1 werc - a minimalist document management system
2 ----------------------------------------------
3 
4 Werc is a content management system and web (anti-)framework designed to be simple to
5 use, simple to setup, simple to hack on, and not get on the way while allowing
6 users easy customization.
7 
8 For more information see the official website: http://werc.cat-v.org/
9 
10 
11 Installation
12 ------------
13 
14 Requirements:
15 
16 * Plan 9 from User Space: http://plan9.us - Or 9base-5 or later: http://tools.suckless.org/9base
17 * An http server that can handle CGIs
18 
19 Instructions:
20 
21 Untar werc at your desired location, configure httpd to use
22 /path-to-your-werc-installation/bin/werc.rc as a cgi-script, it is recommended
23 that you make werc.rc handle all non-static files (this can be done by setting
24 it up as your 404 handler) and setup your virtual hosts to handle static files
25 by setting the document root for the domain to
26 /path-to-werc-installation/sites/yourdomain.com/, and create a directory for
27 your web site under sites/ where you can start adding content right away.
28 
29 If you will want to allow updates via the web interface (eg., for wiki or
30 comments apps) make sure all files under sites/ are writable by the user your
31 cgi will run as, usually www-data, for example by doing: chown -R :www-data
32 sites/; chmod -R g+w sites/
33 
34 If your Plan 9 from User Space installation is located somewhere else than the
35 standard /usr/local/plan9/ you will need to edit the first line of bin/werc.rc
36 (Note that p9p is picky about where it is located, once you run ./INSTALL you
37 should *not* move it to a different directory without running ./INSTALL again.)
38 
39 For general configuration options copy etc/initrc to etc/initrc.local and
40 customize it as needed. Site (and directory) specific options can be set in a
41 sites/example.com/_werc/config file inside the site's directory. To customize
42 templates and included files you can store your own version of the files in
43 lib/ under sites/example.com/_werc/lib
44 
45 The source tree for the werc website is included under sites/werc.cat-v.org as
46 an example, feel free to use it as a template for your own site.
47 
48 For more details see the documentation section of the website:
49 http://werc.cat-v.org/docs/
50 
51 
52 Contact
53 -------
54 
55 For comments, suggestions, bug reports or patches join the werc9 list in
56 google groups: http://groups.google.com/group/werc9 or the irc channel #plan9
57 in irc.freenode.org
58 
59 If you have a public website that uses werc I would love to hear about it and
60 get feedback about you experience setting it up.
61 
62 If you want to be notified of new releases see the News section of the website
63 or use Freshmeat: http://freshmeat.net/projects/werc/
64 
65 Thanks
66 ------
67 
68 Garbeam, Kris Maglione, sqweek, soul9, mycroftiv, maht, yiyus and many others
69 for their ideas, patches, testing and other contributions.
70 
71 
72 License
73 -------
74 
75 Werc is in the public domain.