README (3248B)
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 in the way while allowing 6 users easy customization. 7 8 For more information see the official website: http://werc.cat-v.org/ 9 10 Installation 11 ------------ 12 13 Requirements: 14 15 * An http server that can handle CGIs 16 * Plan 9 from User Space: http://swtch.com/plan9port, 17 Or 9base-tip: http://tools.suckless.org/9base, 18 Or frontbase: http://openbsd.stanleylieber.com/frontbase 19 20 Note: Werc by default expects the Plan 9 tools to be installed under 21 /bin/, if you have installed them elsewhere you will need to edit the 22 #! line in bin/werc.rc and customize the $plan9port variable in your 23 etc/initrc.local. 24 25 26 Instructions: 27 28 Untar werc at your desired location, configure httpd to use 29 /path-to-your-werc-installation/bin/werc.rc as a cgi-script, it is recommended 30 that you make werc.rc handle all non-static files (this can be done by setting 31 it up as your 404 handler) and setup your virtual hosts to handle static files 32 by setting the document root for the domain to 33 /path-to-werc-installation/sites/yourdomain.com/, and create a directory for 34 your web site under sites/ where you can start adding content right away. 35 36 If you will want to allow updates via the web interface (eg., for wiki or 37 comments apps) make sure all files under sites/ are writable by the user your 38 cgi will run as, usually www-data, for example by doing: chown -R :www-data 39 sites/; chmod -R g+w sites/ 40 41 Werc currently assumes that your website runs http, rather than https. 42 If you are running https, locate and change https mentions using 43 grep http -R bin/ 44 45 If your Plan 9 binaries are located somewhere else than the standard /bin/ you 46 will need to edit the first line of bin/werc.rc (Note that p9p in particular is 47 picky about where it is located, once you run ./INSTALL you should *not* move 48 it to a different directory without running ./INSTALL again.) 49 50 For general configuration options copy etc/initrc to etc/initrc.local and 51 customize it as needed. Site (and directory) specific options can be set in a 52 sites/example.com/_werc/config file inside the site's directory. To customize 53 templates and included files you can store your own version of the files in 54 lib/ under sites/example.com/_werc/lib. 55 56 The source tree for the werc website is included under sites/werc.cat-v.org as 57 an example, feel free to use it as a template for your own site. 58 59 If a vim user, you may want to use a syntax file for rc: 60 https://github.com/weakish/rcshell.vim 61 62 For more details see the documentation section of the website: 63 http://werc.cat-v.org/docs/ 64 65 66 Contact 67 ------- 68 69 For comments, suggestions, bug reports or patches join the werc mailing list 70 at: http://werc.cat-v.org or the irc channel #cat-v in irc.freenode.org 71 72 If you have a public website that uses werc I would love to hear about it and 73 get feedback about you experience setting it up. 74 75 Thanks 76 ------ 77 78 Garbeam, Kris Maglione, sqweek, soul9, mycroftiv, maht, yiyus, cinap_lenrek, 79 khm and many others for their ideas, patches, testing and other contributions. 80 81 82 License 83 ------- 84 85 Werc is in the public domain.