aboutsummaryrefslogtreecommitdiffstats
path: root/README.txt
blob: f14f6ad35e08eded04a229dd4f3d5d12e95dbabb (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
110
111
112
113
114
115
116
117
118
Blogthon
========
Stefan Ritter <xeno@thehappy.de>
:Date: 2012-01-21

Installation
------------
The installation of Blogthon assumes that your webserver 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 the following files/directories into
your webroot:

* blogthon.cgi
* .htaccess (Apache)
* error.css
* styles

Then create 3 directories and 1 empty file:

* entries/
* static/
* plugins/
* linklist

Your webserver needs write access to the entries directory:
[source,sh]
$ chmod 777 entries

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.

Apache
~~~~~~
To enable CGI you just have to run "a2enmod cgi" as root. In some cases you have
to allow .htaccess for Apache:
[source,sh]
<Directory "/path/to/your/webroot/">
	AllowOverride all
</Directory>

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

Lighttpd
~~~~~~~~
First you have to enable cgi support for lighttpd 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:
[source,sh]
$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.

Using Blogthon
--------------
To start blogging you just have to open your favorite editor, write your entry
and save it under entries/:
[source,sh]
vim entries/Title.txt

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.

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":
[source,sh]
vim static/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:
[source,sh]
extern_link: http://your/link

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

Linklist
~~~~~~~~
To add a link to your linklist, just add a line to the linklist file:
[source,sh]
http://some/link Name of your link

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

Tags
~~~~
The first line in entries can (not must!) contain tags. Here's an example:

+tag1 +tag2 +another tag

Unfortunately you have to create the index for all tags manually:
[source,sh]
$ ./blogthon.cgi -t

Additional header lines
~~~~~~~~~~~~~~~~~~~~~~~
If you want to add some lines between the <head> tags, you can place them into
styles/$yourstyle/header.txt.