werc/README

78 lines
2.9 KiB
Plaintext
Raw Normal View History

2008-08-30 21:44:38 -06:00
werc - a minimalist document management system
----------------------------------------------
2009-08-05 09:06:25 -06:00
Werc is a content management system and web (anti-)framework designed to be simple to
2009-02-02 13:31:12 -07:00
use, simple to setup, simple to hack on, and not get on the way while allowing
users easy customization.
2008-08-30 21:44:38 -06:00
2009-01-21 02:27:35 -07:00
For more information see the official website: http://werc.cat-v.org/
2008-08-30 21:44:38 -06:00
Installation
------------
Requirements:
2008-09-22 03:09:44 -06:00
* An http server that can handle CGIs
* Plan 9 from User Space: http://swtch.com/plan9port - Or 9base-tip: http://tools.suckless.org/9base
Note: Werc by default expects the Plan 9 tools to be installed under
/usr/local/plan9/bin/, if you have installed them elsewhere you will need to
edit the #! line in bin/werc.rc and customize the $plan9port variable in your
etc/initrc.local.
2008-08-30 21:44:38 -06:00
Instructions:
2009-08-05 09:06:25 -06:00
Untar werc at your desired location, configure httpd to use
/path-to-your-werc-installation/bin/werc.rc as a cgi-script, it is recommended
2010-03-24 00:33:24 -06:00
that you make werc.rc handle all non-static files (this can be done by setting
2009-08-05 09:06:25 -06:00
it up as your 404 handler) and setup your virtual hosts to handle static files
by setting the document root for the domain to
/path-to-werc-installation/sites/yourdomain.com/, and create a directory for
your web site under sites/ where you can start adding content right away.
2009-02-25 10:04:00 -07:00
If you will want to allow updates via the web interface (eg., for wiki or
comments apps) make sure all files under sites/ are writable by the user your
cgi will run as, usually www-data, for example by doing: chown -R :www-data
sites/; chmod -R g+w sites/
2008-09-22 03:09:44 -06:00
2009-02-02 13:31:12 -07:00
If your Plan 9 from User Space installation is located somewhere else than the
standard /usr/local/plan9/ you will need to edit the first line of bin/werc.rc
2009-08-05 09:06:25 -06:00
(Note that p9p is picky about where it is located, once you run ./INSTALL you
should *not* move it to a different directory without running ./INSTALL again.)
2009-02-02 13:31:12 -07:00
For general configuration options copy etc/initrc to etc/initrc.local and
customize it as needed. Site (and directory) specific options can be set in a
2008-10-14 00:15:16 -06:00
sites/example.com/_werc/config file inside the site's directory. To customize
2009-02-02 13:31:12 -07:00
templates and included files you can store your own version of the files in
lib/ under sites/example.com/_werc/lib.
2009-02-02 13:31:12 -07:00
2009-02-02 13:33:02 -07:00
The source tree for the werc website is included under sites/werc.cat-v.org as
an example, feel free to use it as a template for your own site.
2009-02-02 13:31:12 -07:00
For more details see the documentation section of the website:
http://werc.cat-v.org/docs/
2008-09-22 03:09:44 -06:00
2008-08-30 21:44:38 -06:00
Contact
-------
For comments, suggestions, bug reports or patches join the werc mailing list
at: http://werc.cat-v.org or the irc channel #cat-v in irc.freenode.org
2008-08-30 21:44:38 -06:00
If you have a public website that uses werc I would love to hear about it and
get feedback about you experience setting it up.
2009-02-12 18:08:56 -07:00
Thanks
------
Garbeam, Kris Maglione, sqweek, soul9, mycroftiv, maht, yiyus, cinap_lenrek,
khm and many others for their ideas, patches, testing and other contributions.
2009-08-05 09:06:25 -06:00
2008-08-30 21:44:38 -06:00
License
-------
Werc is in the public domain.