aboutsummaryrefslogtreecommitdiff
path: root/README
blob: a2bbcef1d8b4706b74972e258e98f61ef4f49e4a (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
Author:
   Benjamin Kellermann <Benjamin dot Kellermann at tu-dresden in Germany>
Requirements:
 * ruby
 * git (preferred and default setting) or bzr
 * libgettext-ruby (for localization)
 * htdigest command line tool (sudo aptitude install apache2-utils)
License: 
   GNU AGPL v3 or higher
   see file License

=== Installation ===
1. Place this application into a directory where cgi-scripts are evaluated.
2. Copy config_sample.rb to config.rb to start with a default configuration.
3. The webserver needs the permission to write into the directory 
4. You have to build a .mo file from the .po file in order to use the 
   localization. Type:
      make
   This requires libgettext-ruby-util, potool, and make to be installed.
   If this does not work for you, you can download the .mo files from another
   server, e.g., put https://dudle.inf.tu-dresden.de/locale/de/dudle.mo
   into the directory locale/de.
5. In order to let access control work correctly, the webserver needs 
   auth_digest support. It therefore may help to type:
     sudo a2enmod auth_digest
6. In order to get atom-feed support you need ruby-ratom to be installed.
     sudo gem install ratom

=== Pimp your Installation ===
 * If you want to create your own Stylesheet, you just have to put it in
   the folder »$DUDLE_HOME_FOLDER/css/«. Afterwards you may config this one
   to be the default Stylesheet. Examples can be found here:
     https://dudle.inf.tu-dresden.de/css/
   This is a bazaar repository as well, so you may branch it if you want…
     cd $DUDLE_HOME_FOLDER/css
     bzr branch https://dudle.inf.tu-dresden.de/css/ .
   Send me your Stylesheet if you want it to appear at 
   https://dudle.inf.tu-dresden.de
 * If you want to extend the functionality you might want to place a file
   »main.rb« in $DUDLE_HOME_FOLDER/extension/$YOUR_EXTENSION/main.rb
   Examples can be found here:
     https://dudle.inf.tu-dresden.de/unstable/extensions/
   (which again is a repository ;--))