README - swerc - anselm's simpler werc fork
 (HTM) git clone git://git.suckless.org/swerc
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
       ---
       README (2087B)
       ---
            1 swerc - a minimalist document management system
            2 -----------------------------------------------
            3 
            4 swerc is simple werc, a fork of Uriel's werc at: http://werc.cat-v.org/
            5 
            6 Installation
            7 ------------
            8 
            9 Requirements:
           10 
           11 * An http server that can handle CGIs
           12 * Plan 9 from User Space: http://plan9.us - Or http://tools.suckless.org/9base
           13 * discount markdown: http://www.pell.portland.or.us/~orc/Code/discount/
           14 
           15 Note: swerc by default expects the Plan 9 tools to be installed under
           16 /usr/local/plan9/bin/, if you have installed them elsewhere you will need to
           17 edit the #! line in bin/werc.rc and customize the $plan9port variable in your
           18 etc/initrc.local.
           19 
           20 
           21 Instructions:
           22 
           23 Untar swerc at your desired location, configure httpd to use
           24 /path-to-your-werc-installation/bin/werc.rc as a cgi-script, it is recommended
           25 that you make werc.rc handle all non-static files (this can be done by setting
           26 it up as your 404 handler) and setup your virtual hosts to handle static files
           27 by setting the document root for the domain to
           28 /path-to-werc-installation/sites/yourdomain.com/, and create a directory for
           29 your web site under sites/ where you can start adding content right away.
           30 
           31 If you will want to allow updates via the web interface (eg., for wiki or
           32 comments apps) make sure all files under sites/ are writable by the user your
           33 cgi will run as, usually www-data, for example by doing: chown -R :www-data
           34 sites/; chmod -R g+w sites/
           35 
           36 If your Plan 9 from User Space installation is located somewhere else than the
           37 standard /usr/local/plan9/ you will need to edit the first line of bin/werc.rc
           38 (Note that p9p is picky about where it is located, once you run ./INSTALL you
           39 should *not* move it to a different directory without running ./INSTALL again.)
           40 
           41 For general configuration edit etc/initrc.
           42 Site (and directory) specific options can be set in a
           43 sites/example.com/_werc/config file inside the site's directory.
           44 
           45 Thanks
           46 ------
           47 
           48 Kris Maglione, sqweek, soul9, mycroftiv, maht, yiyus and many others
           49 for their ideas, patches, testing and other contributions.
           50 
           51 License
           52 -------
           53 swerc is in the public domain.