1 # $Id: config.properties-default,v 1.1.2.1 2006/11/11 12:52:06 zak Exp $
2 # Based on mir/etc/config.properties-dist 1.31.2.5
4 # Sample config for Mir
5 # by Matthias <mjordan@code-fu.de> 2001-09-12
6 # reorganized by <init@nadir.org> 2003-02-12
8 # The Mir software realizes a semi-dynamic web service:
9 # The web server that is accessed by readers has pure static
10 # pages. These pages are generated by the Mir software that
11 # consists of a collection of Java servlets and HTML templates.
13 # Mir uses a database server to store the data that is needed to
14 # build the static site.
15 # So there are basically three parts in this config file:
17 # a) general & admin setup
18 # b) static site config
22 # edit this to suit your needs
23 # After editing this file, two steps need to be taken to make the changes effective:
24 # 1. ant has to be invoked.
25 # 2. tomcat needs to be restarted.
27 # This file only contains the properties that are most often changed. To view all
28 # possible config values, refer to the file default.properties, located in the
29 # source directory. Don't change settings in default.properties however, instead
32 # Note: for filename values, by default, files are used relative to the servlet's
35 # The setup uses the following assumptions:
36 # The URL to reach the site is http://mir.someserver.org
37 # The StorageRoot of this URL is /var/www/project/site/
38 # All produced pages and media are located below this directory.
40 ################################################
41 ############ A) GENERAL SETUP ##############
42 ################################################
44 # mir/project an contact information
45 # for display on the site
50 Mir.Contact-email.address=webmaster@$FQDN
51 Mir.Contact-email.name=$FQDN webmaster
53 Mir.Tech-email.address=webmaster@$FQDN
54 Mir.Tech-email.name=$FQDN technical contact
56 Mir.Public-email.address=webmaster@$FQDN
57 Mir.Public-email.name=$FQDN public contact
59 # Default timezone to display times in in admin, producers
60 # use CET for Central European Time (Paris, Amsterdam)
61 # more timezones here: http://www.postgresql.org/docs/7.2/static/timezones.html
63 Mir.DefaultTimezone= America/New_York
65 # Default date/time format
66 # For the syntax of the format, refer to
67 # http://java.sun.com/j2se/1.3/docs/api/java/text/SimpleDateFormat.html
68 Mir.DefaultDateTimeFormat = yyyy-MM-dd HH:mm
70 # For missing values, the FallbackLanguage is used as default
72 Mir.Admin.FallbackLanguage=en
74 #################################
75 # admin interface configuration #
76 #################################
78 # Settings for the admin login:
79 # If the default language is left empty, it will set the accept-language of
80 # the client browser as the default.
82 Mir.Login.DefaultLanguage=en
83 Mir.Login.Languages=en;de;fr;nl;es;pt;eu;sv;tr;zh;gz
85 # Show who's logged in?
87 Mir.Admin.ShowLoggedinUsers=1
89 # enable deletion of comments/articles?
91 Mir.Localizer.Admin.AllowDeleteComment=1
92 Mir.Localizer.Admin.AllowDeleteArticle=1
94 #######################
95 # automated producers #
96 #######################
98 # Which producers need to be called after an article is posted
100 Mir.Localizer.OpenPosting.ContentProducers= \
101 media.new;articles.changed;startpage.generate;synchronization.run
103 # Which producers need to be called after a comment is posted
105 Mir.Localizer.OpenPosting.CommentProducers= \
106 articles.changed;synchronization.run
108 # Which producers need to be called after the "produce all new" link is clicked from admin
110 Mir.Localizer.Producer.AllNewProducers= \
111 media.new;articles.changed;startpage.run;synchronization.run
117 #use rsync to mirror the website to a remote-host
120 Rsync.Script.Path=/var/www/bin/rsync-copy.sh
127 # for extra flexibility editors can edit text-files from within the admin-interface
128 # these files can then be included in webpages using SSI as footer or announcement-box...
130 # a list of directories to edit
132 # <name>:<path>:<file filter>:<0|1 (recursion off or on)> [, ....]
134 ServletModule.FileEdit.Configuration= \
135 includes:/var/www/project/site/includes:.*\\.inc:1
137 ################################################
138 ########### B) STATIC SITE CONFIG #############
139 ################################################
141 # the url of the static site
142 # on the machine where mir runs on
144 Producer.ProductionHost=http://$FQDN
146 # the url of the public site
147 # only different from ProductionHost if pages are copied to
148 # one ore more mirror-servers for delivery
150 Producer.PublicationHost=http://$MIRRORFQDN
152 # Produrce.StorageRoot is the directory, in which
153 # the generated HTML pages will be stored
155 Producer.StorageRoot=$PRODUCTIONDIR
157 # use this property only if the pages are NOT produced under the docRoot
158 # of the webserver. all links in the produced pages are prepended
159 # with Producer.DocRoot
164 #####################
165 # media server URLs #
166 #####################
168 # for better performance or load-sharing
169 # images/media can be copied to (and served from) different servers
170 # only in this case image- and medialinks need different URLs.
172 # the url of the video-server
174 Producer.Video.Host=/video
176 # the url of the audio-server
178 Producer.Audio.Host=/audio
180 # the url of the image-server
182 Producer.Image.Host=/images
184 # the url of the media-server
186 Producer.Media.Host=/media
188 # the url of the real-media-server
190 Producer.RealMedia.Host=rtsp://$MIRRORFQDN/real/
194 ############################################
195 # image/media specific storage directories #
196 ############################################
198 # absolute directory, where the images are saved
200 Producer.Image.Path=$PRODUCTIONDIR/images/
203 # absolute directory, where the media files are saved
205 Producer.Media.Path=$PRODUCTIONDIR/media
207 # absolute directory, where the realmedia data files(ra and rm) are saved
208 # the ram files which point to the RealMedia.Host get saved in the regular Media dir
209 # this should make rsyncing to a separate streaming server much easier
211 Producer.RealMedia.Path=$PRODUCTIONDIR/rtsp
213 # mir creates a small thumbnail-icon for each image posted
214 # relativ directory, where the thumbnails will be saved
216 Producer.Image.IconPath=/icon
223 # by default they are stored in the webservers [docRoot]/img directory
224 # they are distibuted with the mir-source (etc/producer/images)
225 # use the "staticimages.generate" producer once to copy them in place
228 # Tiny Icons for the media types on the newswire summary.
229 # (right hand side of start page)
231 Producer.Icon.TinyImage=photo_small.gif
232 Producer.Icon.TinyAudio=audio_small.gif
233 Producer.Icon.TinyVideo=video_small.gif
234 Producer.Icon.TinyText=text_small.gif
236 #Medium sized icons used at various places
238 Producer.Icon.BigImage=photo_big.gif
239 Producer.Icon.BigAudio=audio_big.gif
240 Producer.Icon.BigVideo=video_big.gif
241 Producer.Icon.BigText=text_big.gif
243 #Icons used for links
245 Producer.ExtLinkName=extlink.gif
246 Producer.IntLinkName=intlink.gif
247 Producer.MailLinkName=maillink.gif
249 # this is the name of the subdirectory where the image-dir
252 Producer.ImageRoot=/img
256 ################################################
257 ########### C) DYNAMIC SITE CONFIG #############
258 ################################################
260 # the main mir-servlet
262 Producer.ActionServlet=/servlet/Mir
264 # the url of the openposting-servlet
266 Producer.OpenAction=https://$SECUREFQDN/$SITE/servlet/OpenMir
268 # the maximum allowed size of an uploaded media file in KB.
270 MaxMediaUploadSize=20000
272 # the maximum number of allowed media items to upload at once.
274 ServletModule.OpenIndy.MaxMediaUploadItems=20
276 # the default number of media items to upload at once
278 ServletModule.OpenIndy.DefaultMediaUploadItems=1
281 ######################
282 # PDF configurations #
283 ######################
285 # the following lines are used to construct PDFs on the fly from one or more articles
286 # for the moment, if you want to change anything else about your pdfs, you
287 # will have to learn some java!
289 # keep in mind that there may not be enough room for all the text you enter as the
290 # value of one these options, if text doesn't appear, the only easy thing to do is
294 # a single line of big text which will appear at the top of the first page of all generated pdfs
298 # about two lines of small text which will appear at the bottom of every page
300 PDF.Footer=Mir-CMS PDF-Newsletter. Content is good, and free to use for non-commercial purposes under the Open Content license. If you have questions, email someone.
302 # the size paper your target audience will likely have in their printers.
303 # pick one of A4 or LETTER
307 ################################################
308 ############ D) DATABASE CONFIG ##############
309 ################################################
311 # specify your database
313 Database.Name=$DBNAME
314 Database.Username=$DBUSER
315 Database.Password=$DBPASS
317 Database.Host=localhost
319 Database.Driver=org.postgresql.Driver
322 ############################################
323 # encoding configuration #
324 ############################################
326 # The default encoding charset used in the written html files as well
327 # as the dynamic output html.
328 Mir.DefaultHTMLCharset=UTF-8
330 # The java equivalent of Mir.DefaultHTMLCharset
331 Mir.DefaultEncoding=UTF8