1 SGBlog -- Git-based CGI blogging engine
2 =======================================
6 SGBlog is a simple blogging engine with a Git-based storage and CGI
7 interface with HTTP-server. It can be used as a cgit replacement for
8 readonly Git repository viewing and Atom feed generation. But it has
11 * URLs are tried to be converted to clickable links
12 * SHA1 hashes are tried to be converted to blog links itself
13 * Relative <link rel> links are included for easy navigation
14 * Each page has ETag and it is checked against the request for client-side
16 * Pages can be gzip-compressed, depending on Accept-Encoding header
21 SGBlog is configured via Hjson configuration file:
24 GitPath: /home/git/pub/stargrave-blog.git
25 Branch: refs/heads/english
26 Title: "English Stargrave's blog"
28 BaseURL: http://blog.stargrave.org
31 AtomId: "urn:uuid:18e2f27c-a668-4e85-822e-b902376be5e3"
32 AtomAuthor: Sergey Matveev
34 # URL to CSS file, optional
36 # Email address of the webmaster, optional
37 Webmaster: "webmaster@example.com"
38 # URL to about page, optional
40 # Optional list of optional Git URLs for corresponding <link rel="vcs-git">
42 git://git.stargrave.org/stargrave-blog.git
43 https://git.stargrave.org/git/stargrave-blog.git
46 # If that ref is set, then comments will be loaded from it
47 CommentsNotesRef: refs/notes/comments
48 # Display link for comment writing, if email is set
49 CommentsEmail: something@example.com
54 Each comment is just a plaintext with From and Date headers. They are
55 stored in concatenated netstring serialized format as a Git note to
56 corresponding commit. They are added through email by feeding email
57 message to sgblog-comment-add.
61 This program is free software: you can redistribute it and/or modify
62 it under the terms of the GNU Affero General Public License as
63 published by the Free Software Foundation, version 3 of the License.
65 This program is distributed in the hope that it will be useful,
66 but WITHOUT ANY WARRANTY; without even the implied warranty of
67 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
68 GNU General Public License for more details.