From 3d2b2ea2d78cb36d768fee77ed7313493aff0197 Mon Sep 17 00:00:00 2001 From: Uriel Date: Tue, 28 Jun 2011 01:50:24 +0000 Subject: [PATCH] Documentation updates: - Try to explain better that werc expects Plan 9 tools in /usr/local/plan9/bin/ - Note possible bug. - Other small doc changes. --- README | 8 +++++++- etc/initrc | 3 +++ sites/default.cat-v.org/_werc/lib/headers.inc | 1 + sites/werc.cat-v.org/development/todo.md | 6 ++++++ sites/werc.cat-v.org/docs/config-options.md | 12 ++++++++++-- 5 files changed, 27 insertions(+), 3 deletions(-) diff --git a/README b/README index 14124d7..a16ca92 100644 --- a/README +++ b/README @@ -13,8 +13,14 @@ Installation Requirements: -* Plan 9 from User Space: http://plan9.us - Or 9base-5 or later: http://tools.suckless.org/9base * An http server that can handle CGIs +* Plan 9 from User Space: http://plan9.us - Or 9base-5 or later: 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: diff --git a/etc/initrc b/etc/initrc index 26f09d9..fa7ede0 100644 --- a/etc/initrc +++ b/etc/initrc @@ -14,6 +14,9 @@ plan9port=$PLAN9 # If you use 9base, it should point to your 9base root, try for example: #plan9port=/usr/lib/9base # This is the default 9base install path in Debian. +# If rc is not installed as /usr/local/plan9/bin/rc you will also need to change +# the #! line in bin/werc.rc! + # Path, make sure the plan9port /bin directory is included before /bin # Keep '.' in path! It is needed. path=($plan9port/bin . ./bin ./bin/contrib /bin /usr/bin) diff --git a/sites/default.cat-v.org/_werc/lib/headers.inc b/sites/default.cat-v.org/_werc/lib/headers.inc index f2deabd..6e59ad2 100644 --- a/sites/default.cat-v.org/_werc/lib/headers.inc +++ b/sites/default.cat-v.org/_werc/lib/headers.inc @@ -2,3 +2,4 @@ + diff --git a/sites/werc.cat-v.org/development/todo.md b/sites/werc.cat-v.org/development/todo.md index e0f6c34..520074c 100644 --- a/sites/werc.cat-v.org/development/todo.md +++ b/sites/werc.cat-v.org/development/todo.md @@ -60,6 +60,7 @@ Future Plansi and Blue Sky Similar frameworks to be investigated and mined for good ideas to steal: * TinyTim: http://www.reddit.com/r/programming/duplicates/dbaee/ + * nanoblogger: http://nanoblogger.sourceforge.net/ Known Bugs @@ -69,6 +70,11 @@ Known Bugs * If a dir under apps/ doesn't contain an app.rc file, werc fails to start. A possible fix would be to replace $werc_apps default with `apps/*/app.rc` instead of `apps/*/`, this would be backwards incompatible, but I doubt anyone uses that option. * Links in Blagh feeds become confused if markdown 'references' are used, markdown references suck, but I guess we need to address this somehow... * Somewhat similarly to the abouve, relative urls in imgs, links, etc. can easily break when used in Blagh posts, so it is not all markdown's fault. +* .md files of the following form, without a new line after the last = seem to cause problems in some setups: + + Foo Bar + ======= + Fixed or WFM Bugs diff --git a/sites/werc.cat-v.org/docs/config-options.md b/sites/werc.cat-v.org/docs/config-options.md index 7e4179d..010504e 100644 --- a/sites/werc.cat-v.org/docs/config-options.md +++ b/sites/werc.cat-v.org/docs/config-options.md @@ -52,9 +52,17 @@ Access Control and Permissions The permissions system is very flexible, for example to only allow access to members of the group 'editors' you can do something like: - if(! check_user editors) - perm_redirect /_users/login + switch ($req_path) { + case /_users/login + case /pub/* + case /robots.txt + case * + if(! check_user editors) + perm_redirect /_users/login + } + To automatically redirect users without permission to the login page if they are not members of the group 'editors'. See also [the documentation on user and group management](user_management). +