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