aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: de96cc94c90375f5d1fd069d60485fbb3603f601 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
Index:

 1) Installation
 1.1) Apache
 1.2) Lighttpd
 2) Entries
 3) Staticpages
 4) Comments
 5) Linklist


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:

<Directory /this/is/where/your/www/root/is/>
    Options +ExecCGI
    AddHandler cgi-script .cgi
    DirectoryIndex blogthon.cgi
</Directory>

To finish the installation, reload Apache with
'/etc/init.d/apache2 force-reload' as root.


1.2) Lighttpd
=============
First you have to enable cgi support for lighttp by running 'lighty-enable-mod cgi' as root.
Now create a new config in /etc/lighttpd/conf-available/ named 50-blogthon.conf or something similar with this content:

$HTTP["host"] == "YourBlogURL" {
	cgi.assign = ( ".cgi" => "/usr/bin/python" )
	index-file.names  = ( "blogthon.cgi" )
}

Enable this config by runnung 'lighty-enable-mod blogthon' and restart lighttpd with
'/etc/init.d/lighttpd restart' as root.


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)
The suffix can be set in your configuration file. Default is '.txt'.

While parsing an entry, blogthon places a <br /> behind each line, except for
lines with <ul>, <li>, <table>, etc... So you don't need to make your own
layout using <br /> tags. Aside from that you can certainly use <p> elements
and all other HTML tags.

Time and date of your entry are taken from the timestamp of your file.
Unfortunately this timestamp changes when you edit your file again. As a
workaround I use a small shellscript instead of starting vim/emacs/...:
http://git.fucktheforce.de/?p=xeno;a=blob_plain;f=viod;hb=HEAD


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

If you want to make a staticpage to be a link to an extern page, you just have
to place the following content in the first line:
extern_link: http://your/link.


4) Comments
===========
Comments are saved under entries/ like all entries, but with the suffix
'.comments'. The syntax in this file is like this:

-.Nickname
+.Date
.some text
.more text


5) Linklist
===========
To add a link to your linklist, just add a line to the linklist file:

http://some/link name of your link

Of course you can use empty lines to split different sorts of links.