Edit page GeekiGeeki
[wiki.git] / GeekiGeeki
1 == Geeki Geeki, the Stupid Stupid Wiki Wiki ==
2
3 <div style="float: right">GerryStich.png</div>
4
5 GeekiGeeki is a minimalistic wiki with a [[http://git.or.cz/ | Git]]
6 backend, a high features/complexity ratio and a clean syntax.
7 Check the EditingTips page for an idea the supported markup.
8
9 <div style="font-size: large; color: red;  text-align: center">
10 For all your geeky wiki needs, GeekiGeeki is **the** stupid choice you can't avoid!
11 </div>
12
13 Tags: [[tags/fast|fast]], [[tags/stupid|stupid]], [[tags/!bloated|!bloated]], [[tags/h4x0r|h4x0r]] [[tags/cheapasincheapbeer|cheapasincheapbeer]]
14
15
16 == Features ==
17
18  * S^3: Simple, Small, Stupid
19  * Rich, clean markup syntax, highly compatible with WikiCreole and MoinMoin
20  * Versioned and distributed storage backend based on git
21  * Easy to interface with other storage back-ends through a glue script
22  * Interfaces with GitWeb for history browsing, RSS...
23  * Consistent use of CSS for easy theming
24  * HTML pass-through for powerful formatting
25  * Pluggable macros
26  * Page includes (templates with parameters coming)
27  * Blogging support
28  * Hierarchical namespace with automatic directory listing
29  * [[Picture]] gallery (poor man's Flick'r)
30  * Video playback (poor man's You Tube)
31  * User accounts supported through web server's HTTP basic auth
32  * Per-page ACLs
33  * Title and full-text search with full regex power
34  * Easy drop-in installation (no WSGI, mod_python, FCGI...)
35  * Fast!
36  * Small! Codebase is just 800 LOCs!
37  * Derived from PikiWiki, like MoinMoin
38  * OpenSource, FreeSoftware, CheapBeer... pleases anyone
39  * GuruMeditation alerts :-)
40
41 == License ==
42
43 Geeki Geeki is Gratis Software as in Gratuitous Speech, not Cheap as in Cheap Beer.
44 Consult your lawyer before using to check whether this is compatible with your current
45 brand of beer.
46
47 Naa! Geeki Geeki is really distributed under the [[http://www.fsf.org/licensing/licenses/agpl-3.0.html|GNU General Public License]], version 3.0 or later.
48
49 == Download ==
50
51 ==== Releases ====
52
53 || 01-May-2009 || [[http://www.codewiz.org/wikigit/geekigeeki.git?a=snapshot;h=v4.0|geekigeeki-4.0.tar.gz]] ||
54 || 11-Dec-2008 || [[http://www.codewiz.org/wikigit/geekigeeki.git?a=snapshot;h=v3.0|geekigeeki-3.0.tar.gz]] ||
55 || 23-Sep-2008 || [[http://www.codewiz.org/wikigit/geekigeeki.git?a=snapshot;h=v2.0|geekigeeki-2.0.tar.gz]] ||
56
57
58 ==== Source ====
59
60 You can obtain the latest version -- actually ''any'' version -- through git:
61
62 {{{
63 git clone http://www.codewiz.org/~bernie/git/geekigeeki.git/
64 git clone git://www.codewiz.org/~bernie/geekigeeki.git/
65 }}}
66
67 ===== Revision history =====
68
69 Browse it online with GitWeb: http://www.codewiz.org/wikigit/geekigeeki.git
70
71 ===== Individual source files =====
72
73  * [[http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/geekigeeki.py        | geekigeeki.py      ]] -- The CGI itself
74  * [[http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/geekigeeki.conf.py.. | geekigeeki.conf.py ]] -- Sample site config
75  * [[http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/post_edit_hook.sh    | post_edit_hook.sh  ]] -- Some glue to integrate with git
76  * [[http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/wiki_apache.conf     | wiki_apache.conf   ]] -- Sample conf file for Apache
77  * [[sys/geekigeeki.css                                                                  | geekigeeki.css     ]] -- The stylesheet used at this site
78
79 == Installation ==
80
81 The easiest way is:
82
83  * clone the git repository anywhere you like
84  * edit **wiki_apache.conf** to adapt it to your system, and move or link it to your Apache configuration directory.
85  * customize the wiki through geekigeeki.conf.py
86  * create a git repository for your wiki:
87  {{{
88  mkdir data
89  cd data
90  git init --shared=group
91  chgrp -R apache .
92  }}}
93  * reload Apache
94
95 == Update procedure ==
96
97 If you cloned the repository as suggested, updating and downgrading is easy:
98
99 {{{
100 git pull
101 }}}
102
103 to switch to a different version of GeekiGeeki:
104
105 {{{
106 git checkout {tree-ish}
107 }}}
108
109 where '##{tree-ish}## could be a tag, a branch name, or a specific commit.
110
111 == Contributing ==
112
113 Please send your patches!  See the GeekiGeekiToDo list for ideas.
114
115 Bugfixes and cute hacks welcome.  BloatWare //will// be rejected: this is
116 a minimalistic wiki, damn'it!