From ecd758e7f15916237a0c18cf940e17b7df206c1a Mon Sep 17 00:00:00 2001 From: Stefan Ritter Date: Mon, 7 Dec 2009 01:51:35 +0100 Subject: More documentation --- README | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 56 insertions(+), 11 deletions(-) diff --git a/README b/README index baa367a..abee632 100644 --- a/README +++ b/README @@ -1,13 +1,58 @@ Index: - 1) Entries - 2) Staticpages - 3) Comments - 4) Linklist + 1) Installation + 1.1) Apache + 1.2) Lighttpd + 2) Entries + 3) Staticpages + 4) Comments + 5) Linklist -1) Entries +1) Installation +=============== +The installation of Blogthon assumes that your httpd supports CGI and Python +is installed. If all this is given, you can download Blogthon in a directory +of your choice. After that you have to symlink 2 files into your www directory: + * blogthon.cgi + * styles + +Then create 3 directories and 1 empty file: + + * entries/ + * static/ + * plugins/ + * linklist + +Now copy the example configuration into your www directory, or to +../blogthonrc or ../.blogthonrc. + +If all this is done, you can continue with setting up your httpd. + + +1.1) Apache +=========== +To enable CGI you just have to run 'a2enmod cgi' as root. Now put something +like this in /etc/apache2/sites-available/default: + + + Options +ExecCGI + AddHandler cgi-script .cgi + DirectoryIndex blogthon.cgi + + +To finish the installation, reload Apache with +'/etc/init.d/apache2 force-reload' as root. + + +1.2) Lighttpd +============= +Coming soon... + + +2) Entries +========== To start blogging you just have to open your favorite editor, write your entry and save it under entries/. The filename should be like this: (entry title).(suffix) @@ -24,8 +69,8 @@ workaround I use a small shellscript instead of starting vim/emacs/...: http://git.fucktheforce.de/?p=xeno;a=blob_plain;f=viod;hb=HEAD -2) Staticpages - +3) Staticpages +============== Staticpages are placed under static/ without a suffix. To sort them, you can start the filename with a literal and -. So '01-Foo' will be placed before '02-Bar'. @@ -35,8 +80,8 @@ to place the following content in the first line: extern_link: http://your/link. -3) Comments - +4) Comments +=========== Comments are saved under entries/ like all entries, but with the suffix '.comments'. The syntax in this file is like this: @@ -46,8 +91,8 @@ Comments are saved under entries/ like all entries, but with the suffix .more text -4) Linklist - +5) Linklist +=========== To add a link to your linklist, just add a line to the linklist file: http://some/link name of your link -- cgit v1.2.3