etc/config.properties-dist

   1 #
   2 # Sample config for Mir
   3 # by Matthias <mjordan@code-fu.de> 2001-09-12
   4 # reorganized by <init@nadir.org>  2003-02-12
   5 #
   6 # The Mir software realizes a semi-dynamic web service:
   7 # The web server that is accessed by readers has pure static
   8 # pages. These pages are generated by the Mir software that
   9 # consists of a collection of Java servlets and HTML templates.
  10 #
  11 # Mir uses a database server to store the data that is needed to
  12 # build the static site.
  13 # So there are basically three parts in this config file:
  14 #
  15 # a) general & admin setup
  16 # b) static site config
  17 # c) dynamic site
  18 # d) database config
  19 #
  20 # edit this to suit your needs
  21 # After editing this file, two steps need to be taken to make the changes effective:
  22 #   1. ant has to be invoked.
  23 #   2. tomcat needs to be restarted.
  24 #
  25 # This file only contains the properties that are most often changed. To view all
  26 # possible config values, refer to the file default.properties, located in the
  27 # source directory. Don't change settings in default.properties however, instead
  28 # use this file.
  29 #
  30 # Note: for filename values, by default, files are used relative to the servlet's
  31 # WEB-INF directory.
  32 #
  33 # The setup uses the following assumptions:
  34 # The URL to reach the site is http://mir.someserver.org
  35 # The StorageRoot of this URL is /var/www/project/site/
  36 # All produced pages and media are located below this directory.
  37
  38 ################################################
  39 ############    A) GENERAL SETUP  ##############
  40 ################################################
  41
  42 # mir/project an contact information
  43 # for display on the site
  44 #
  45 Mir.Name=mir.someserver.org
  46 Mir.Shortname=mir
  47
  48 Mir.Contact-email.address=mir-project@somemailserver.org
  49 Mir.Contact-email.name=mir-project mailinglist
  50
  51 Mir.Tech-email.address=mir-admins@somemailserver.org
  52 Mir.Tech-email.name=mir-admins mailinglist
  53
  54 Mir.Public-email.address=project@somemailserver.org
  55 Mir.Public-email.name=project mailinglist
  56
  57 # Default timezone to display times in in admin, producers
  58 # use CET for Central European Time (Paris, Amsterdam)
  59 # more timezones here: http://www.postgresql.org/docs/7.2/static/timezones.html
  60 #
  61 Mir.DefaultTimezone= UTC
  62
  63 # Default date/time format
  64 # For the syntax of the format, refer to
  65 # http://java.sun.com/j2se/1.3/docs/api/java/text/SimpleDateFormat.html
  66 Mir.DefaultDateTimeFormat = yyyy-MM-dd HH:mm
  67
  68 # where to put the lucene index
  69 # for the build in searchengine
  70 # (must be creatable and writable by the tomcat user)
  71 IndexPath=index
  72
  73 # temp-dir used for media-uploads
  74 TempDir=/tmp
  75
  76 # Logging
  77 #
  78 Log.LogClass = mir.log.log4j.LoggerImpl
  79 Log.log4j.ConfigurationFile = etc/log4j.properties
  80 Log.Home = log
  81
  82 # Mir.Localizer
  83 # for your additional site-specific java-code
  84 #
  85 Mir.Localizer=mircoders.localizer.basic.MirBasicLocalizer
  86
  87 # The location of the producer specifiations
  88 #
  89 Mir.Localizer.ProducerConfigFile=etc/producer/producers.xml
  90
  91 # For missing values, the FallbackLanguage is used as default
  92 #
  93 Mir.Admin.FallbackLanguage=en
  94
  95 # the templates
  96 #
  97 Mir.Localizer.Producer.GeneratorLibrary= default=freemarker(etc/producer/)
  98 Mir.Localizer.Admin.GeneratorLibrary= default=freemarker(templates/admin/)
  99 Mir.Localizer.OpenPosting.GeneratorLibrary= default=freemarker(etc/open/)
 100
 101
 102 #################################
 103 # admin interface configuration #
 104 #################################
 105
 106 # Settings for the admin login:
 107 # If the default language is left empty, it will set the accept-language of
 108 # the client browser as the default.
 109 #
 110 Mir.Login.DefaultLanguage=en
 111 Mir.Login.Languages=en;de;fr;nl;es;pt;eu;sv;tr;zh;gz
 112
 113 # Show who's logged in?
 114 #
 115 Mir.Admin.ShowLoggedinUsers=1
 116
 117 # How should the custom operations (hide etc) in article and comment lists
 118 # be presented?
 119 # 0 = links, 1 = checkboxes, 2 = a listbox
 120 #
 121 Mir.Localizer.Admin.ListOperationsFlavor=1
 122
 123 # How should the topics be presented on the article edit page?
 124 # 0 = in a multiselect list box, 1 = checkboxes
 125 #
 126 Mir.Localizer.Admin.TopicListFlavor=1
 127
 128 # For the checkboxes flavour, how many columns should there be?
 129 #
 130 Mir.Localizer.Admin.TopicListColumns=3
 131
 132 # In which order should the topic appear?
 133 #
 134 Mir.Localizer.Admin.TopicListOrder=title
 135
 136 # enable deletion of comments/articles?
 137 #
 138 Mir.Localizer.Admin.AllowDeleteComment=1
 139 Mir.Localizer.Admin.AllowDeleteArticle=1
 140
 141 # Article Preview Link URL (Link to produced articles from within admin)
 142 #
 143 Article.PublicUrl=http://mir.code-foo.org/en/${to_content.date.formatted.yyyy}/${to_content.date.formatted.MM}/${to_content.id}.shtml
 144 Comment.PublicUrl=http://mir.code-foo.org/en/${date.formatted.yyyy}/${date.formatted.MM}/${id}.shtml
 145
 146
 147 #######################
 148 # automated producers #
 149 #######################
 150
 151 # Which producers need to be called after an article is posted
 152 #
 153 Mir.Localizer.OpenPosting.ContentProducers= \
 154 media.new;articles.changed;startpage.generate;synchronization.run
 155
 156 # Which producers need to be called after a comment is posted
 157 #
 158 Mir.Localizer.OpenPosting.CommentProducers= \
 159 articles.changed;synchronization.run
 160
 161 # Which producers need to be called after the "produce all new" link is clicked from admin
 162 #
 163 Mir.Localizer.Producer.AllNewProducers= \
 164 media.new;articles.changed;startpage.run;synchronization.run
 165
 166 #########
 167 # rsync #
 168 #########
 169
 170 #use rsync to mirror the website to a remote-host
 171 #
 172 Rsync=no
 173 Rsync.Script.Path=/var/www/bin/rsync-copy.sh
 174
 175
 176 ###################
 177 # FileEdit module #
 178 ###################
 179
 180 # for extra flexibility editors can edit text-files from within the admin-interface
 181 # these files can then be included in webpages using SSI as footer or announcement-box...
 182 #
 183 # a list of directories to edit
 184 # format:
 185 #      <name>:<path>:<file filter>:<0|1 (recursion off or on)> [, ....]
 186 #
 187 ServletModule.FileEdit.Configuration= \
 188   includes:/var/www/project/site/includes:.*\\.inc:1
 189
 190
 191
 192
 193 ################################################
 194 ###########  B) STATIC SITE CONFIG #############
 195 ################################################
 196
 197 # the url of the static site
 198 # on the machine where mir runs on
 199 #
 200 Producer.ProductionHost=http://mir.someserver.org
 201
 202 # the url of the public site
 203 # only different from ProductionHost if pages are copied to
 204 # one ore more mirror-servers for delivery
 205 #
 206 Producer.PublicationHost=http://mir.someserver.org
 207
 208 # Produrce.StorageRoot is the directory, in which
 209 # the generated HTML pages will be stored
 210 #
 211 Producer.StorageRoot=/var/www/project/site/
 212
 213 # use this property only if the pages are NOT produced under the docRoot
 214 # of the webserver. all links in the produced pages are prepended
 215 # with Producer.DocRoot
 216 #
 217 Producer.DocRoot=
 218
 219
 220 #####################
 221 # media server URLs #
 222 #####################
 223
 224 # for better performance or load-sharing
 225 # images/media can be copied to (and served from) different servers
 226 # only in this case image- and medialinks need different URLs.
 227
 228 # the url of the video-server
 229 #
 230 Producer.Video.Host=http://mir.someserver.org/video
 231
 232 # the url of the audio-server
 233 #
 234 Producer.Audio.Host=http://mir.someserver.org/audio
 235
 236 # the url of the image-server
 237 #
 238 Producer.Image.Host=http://mir.someserver.org/images
 239
 240 # the url of the media-server
 241 #
 242 Producer.Media.Host=http://mir.someserver.org/media
 243
 244 # the url of the real-media-server
 245 #
 246 Producer.RealMedia.Host=rtsp://some.streamingmedia.server/somedir/
 247
 248
 249
 250 ############################################
 251 # image/media specific storage directories #
 252 ############################################
 253
 254 # absolute directory, where the images are saved
 255 #
 256 Producer.Image.Path=/var/www/project/site/images/
 257
 258
 259 # absolute directory, where the media files are saved
 260 #
 261 Producer.Media.Path=/var/www/project/site/media
 262
 263 # absolute directory, where the realmedia data files(ra and rm) are saved
 264 # the ram files which point to the RealMedia.Host get saved in the regular Media dir
 265 # this should make rsyncing to a separate streaming server much easier
 266 #
 267 Producer.RealMedia.Path=/var/www/project/site/rtsp
 268
 269 # mir creates a small thumbnail-icon for each image posted
 270 # relativ directory, where the thumbnails will be saved
 271 #
 272 Producer.Image.IconPath=/icon
 273
 274
 275 ####################
 276 # media-type-icons #
 277 ####################
 278
 279 # by default they are stored in the webservers [docRoot]/img directory
 280 # they are distibuted with the mir-source (etc/producer/images)
 281 # use the "staticimages.generate" producer once to copy them in place
 282 #
 283
 284 # Tiny Icons for the media types on the newswire summary.
 285 # (right hand side of start page)
 286 #
 287 Producer.Icon.TinyImage=photo_small.gif
 288 Producer.Icon.TinyAudio=audio_small.gif
 289 Producer.Icon.TinyVideo=video_small.gif
 290 Producer.Icon.TinyText=text_small.gif
 291
 292 #Medium sized icons used at various places
 293 #
 294 Producer.Icon.BigImage=photo_big.gif
 295 Producer.Icon.BigAudio=audio_big.gif
 296 Producer.Icon.BigVideo=video_big.gif
 297 Producer.Icon.BigText=text_big.gif
 298
 299 #Icons used for links
 300 #
 301 Producer.ExtLinkName=extlink.gif
 302 Producer.IntLinkName=intlink.gif
 303 Producer.MailLinkName=maillink.gif
 304
 305 # this is the name of the subdirectory where the image-dir
 306 # will be linked to.
 307 #
 308 Producer.ImageRoot=/img
 309
 310
 311
 312 ################################################
 313 ########### C) DYNAMIC SITE CONFIG #############
 314 ################################################
 315
 316 # the main mir-servlet
 317 #
 318 Producer.ActionServlet=/servlet/Mir
 319
 320 # the url of the openposting-servlet
 321 #
 322 Producer.OpenAction=http://mir.someserver.org/servlet/OpenMir
 323
 324 # the maximum allowed size of an uploaded media file in KB.
 325 #
 326 MaxMediaUploadSize=20000
 327
 328 # the maximum number of allowed media items to upload at once.
 329 #
 330 ServletModule.OpenIndy.MaxMediaUploadItems=20
 331
 332 # the default number of media items to upload at once
 333 #
 334 ServletModule.OpenIndy.DefaultMediaUploadItems=1
 335
 336
 337 ######################
 338 # PDF configurations #
 339 ######################
 340
 341 # the following lines are used to construct PDFs on the fly from one or more articles
 342 # for the moment, if you want to change anything else about your pdfs, you
 343 # will have to learn some java!
 344 #
 345 # keep in mind that there may not be enough room for all the text you enter as the
 346 # value of one these options, if text doesn't appear, the only easy thing to do is
 347 # use less text!
 348 #
 349
 350 # a single line of big text which will appear at the top of the first page of all generated pdfs
 351 #
 352 PDF.Title=SOME MIR-SITE
 353
 354 # about two lines of small text which will appear at the bottom of every page
 355 #
 356 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.
 357
 358 # the size paper your target audience will likely have in their printers.
 359 # pick one of A4 or LETTER
 360 #
 361 PDF.PageSize=A4
 362
 363 ################################################
 364 ############ D) DATABASE CONFIG   ##############
 365 ################################################
 366
 367 # specify your database
 368 #
 369 Database.Name=Mir
 370 Database.Username=postgres
 371 Database.Password=
 372
 373 Database.Host=localhost
 374 Database.Port=5432
 375 Database.Driver=org.postgresql.Driver
 376
 377
 378 ############################################
 379 # encoding configuration                   #
 380 ############################################
 381
 382 # The default encoding charset used in the written html files as well
 383 # as the dynamic output html.
 384 Mir.DefaultHTMLCharset=UTF-8
 385
 386 # The java equivalent of Mir.DefaultHTMLCharset
 387 Mir.DefaultEncoding=UTF8