Go to file
2019-12-07 21:58:39 -05:00
apps apps/blagh/: fix rss (passes validation), partially fix atom (does not pass validation) 2019-12-07 21:55:44 -05:00
bin bin/werclib.rc: replace fn datei and fn datet (both broken) with fn ndate (implements 9front's date -i, -m, and -t) 2019-12-07 21:55:00 -05:00
etc etc/initrc: change default markdown formatter from markdown.pl (no modern perl on plan 9) to md2html.awk (works everywhere) 2016-12-02 20:35:58 -05:00
lib Start to convert templates to HTML 5 2009-07-19 04:02:30 +02:00
pub initial import of changes from 9front bikeshedding; bundle rc-httpd 2016-02-04 15:05:05 -05:00
sites sites/werc.cat-v.org/index.md: update repo and contact urls 2019-12-07 21:58:39 -05:00
tpl Fix sitemap.tpl when $sitedir is an absolute path. Thanks again to arg for reporting, tracking, and fixing this bug! 2009-08-09 21:02:42 +02:00
.hgignore initial import of changes from 9front bikeshedding; bundle rc-httpd 2016-02-04 15:05:05 -05:00
README initial import of changes from 9front bikeshedding; bundle rc-httpd 2016-02-04 15:05:05 -05:00

werc - a minimalist document management system
----------------------------------------------

Werc is a content management system and web (anti-)framework designed to be simple to
use, simple to setup, simple to hack on, and not get on the way while allowing
users easy customization.

For more information see the official website: http://werc.cat-v.org/


Installation
------------

Requirements:

* 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.


Instructions:

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
that you make werc.rc handle all non-static files (this can be done by setting
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.

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/

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
(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.)

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
sites/example.com/_werc/config file inside the site's directory. To customize
templates and included files you can store your own version of the files in
lib/ under sites/example.com/_werc/lib.

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.

For more details see the documentation section of the website:
http://werc.cat-v.org/docs/


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

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.

Thanks
------

Garbeam, Kris Maglione, sqweek, soul9, mycroftiv, maht, yiyus, cinap_lenrek,
khm and many others for their ideas, patches, testing and other contributions.


License
-------

Werc is in the public domain.