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 # For missing values, the FallbackLanguage is used as default
  69 #
  70 Mir.Admin.FallbackLanguage=en
  71
  72 #################################
  73 # admin interface configuration #
  74 #################################
  75
  76 # Settings for the admin login:
  77 # If the default language is left empty, it will set the accept-language of
  78 # the client browser as the default.
  79 #
  80 Mir.Login.DefaultLanguage=en
  81 Mir.Login.Languages=en;de;fr;nl;es;pt;eu;sv;tr;zh;gz
  82
  83 # Show who's logged in?
  84 #
  85 Mir.Admin.ShowLoggedinUsers=1
  86
  87 # enable deletion of comments/articles?
  88 #
  89 Mir.Localizer.Admin.AllowDeleteComment=1
  90 Mir.Localizer.Admin.AllowDeleteArticle=1
  91
  92 #######################
  93 # automated producers #
  94 #######################
  95
  96 # Which producers need to be called after an article is posted
  97 #
  98 Mir.Localizer.OpenPosting.ContentProducers= \
  99 media.new;articles.changed;startpage.generate;synchronization.run
 100
 101 # Which producers need to be called after a comment is posted
 102 #
 103 Mir.Localizer.OpenPosting.CommentProducers= \
 104 articles.changed;synchronization.run
 105
 106 # Which producers need to be called after the "produce all new" link is clicked from admin
 107 #
 108 Mir.Localizer.Producer.AllNewProducers= \
 109 media.new;articles.changed;startpage.run;synchronization.run
 110
 111 #########
 112 # rsync #
 113 #########
 114
 115 #use rsync to mirror the website to a remote-host
 116 #
 117 Rsync=no
 118 Rsync.Script.Path=/var/www/bin/rsync-copy.sh
 119
 120
 121 ###################
 122 # FileEdit module #
 123 ###################
 124
 125 # for extra flexibility editors can edit text-files from within the admin-interface
 126 # these files can then be included in webpages using SSI as footer or announcement-box...
 127 #
 128 # a list of directories to edit
 129 # format:
 130 #      <name>:<path>:<file filter>:<0|1 (recursion off or on)> [, ....]
 131 #
 132 ServletModule.FileEdit.Configuration= \
 133   includes:/var/www/project/site/includes:.*\\.inc:1
 134
 135 ################################################
 136 ###########  B) STATIC SITE CONFIG #############
 137 ################################################
 138
 139 # the url of the static site
 140 # on the machine where mir runs on
 141 #
 142 Producer.ProductionHost=http://mir.someserver.org
 143
 144 # the url of the public site
 145 # only different from ProductionHost if pages are copied to
 146 # one ore more mirror-servers for delivery
 147 #
 148 Producer.PublicationHost=http://mir.someserver.org
 149
 150 # Produrce.StorageRoot is the directory, in which
 151 # the generated HTML pages will be stored
 152 #
 153 Producer.StorageRoot=/var/www/project/site/
 154
 155 # use this property only if the pages are NOT produced under the docRoot
 156 # of the webserver. all links in the produced pages are prepended
 157 # with Producer.DocRoot
 158 #
 159 Producer.DocRoot=
 160
 161
 162 #####################
 163 # media server URLs #
 164 #####################
 165
 166 # for better performance or load-sharing
 167 # images/media can be copied to (and served from) different servers
 168 # only in this case image- and medialinks need different URLs.
 169
 170 # the url of the video-server
 171 #
 172 Producer.Video.Host=http://mir.someserver.org/video
 173
 174 # the url of the audio-server
 175 #
 176 Producer.Audio.Host=http://mir.someserver.org/audio
 177
 178 # the url of the image-server
 179 #
 180 Producer.Image.Host=http://mir.someserver.org/images
 181
 182 # the url of the media-server
 183 #
 184 Producer.Media.Host=http://mir.someserver.org/media
 185
 186 # the url of the real-media-server
 187 #
 188 Producer.RealMedia.Host=rtsp://some.streamingmedia.server/somedir/
 189
 190
 191
 192 ############################################
 193 # image/media specific storage directories #
 194 ############################################
 195
 196 # absolute directory, where the images are saved
 197 #
 198 Producer.Image.Path=/var/www/project/site/images/
 199
 200
 201 # absolute directory, where the media files are saved
 202 #
 203 Producer.Media.Path=/var/www/project/site/media
 204
 205 # absolute directory, where the realmedia data files(ra and rm) are saved
 206 # the ram files which point to the RealMedia.Host get saved in the regular Media dir
 207 # this should make rsyncing to a separate streaming server much easier
 208 #
 209 Producer.RealMedia.Path=/var/www/project/site/rtsp
 210
 211 # mir creates a small thumbnail-icon for each image posted
 212 # relativ directory, where the thumbnails will be saved
 213 #
 214 Producer.Image.IconPath=/icon
 215
 216
 217 ####################
 218 # media-type-icons #
 219 ####################
 220
 221 # by default they are stored in the webservers [docRoot]/img directory
 222 # they are distibuted with the mir-source (etc/producer/images)
 223 # use the "staticimages.generate" producer once to copy them in place
 224 #
 225
 226 # Tiny Icons for the media types on the newswire summary.
 227 # (right hand side of start page)
 228 #
 229 Producer.Icon.TinyImage=photo_small.gif
 230 Producer.Icon.TinyAudio=audio_small.gif
 231 Producer.Icon.TinyVideo=video_small.gif
 232 Producer.Icon.TinyText=text_small.gif
 233
 234 #Medium sized icons used at various places
 235 #
 236 Producer.Icon.BigImage=photo_big.gif
 237 Producer.Icon.BigAudio=audio_big.gif
 238 Producer.Icon.BigVideo=video_big.gif
 239 Producer.Icon.BigText=text_big.gif
 240
 241 #Icons used for links
 242 #
 243 Producer.ExtLinkName=extlink.gif
 244 Producer.IntLinkName=intlink.gif
 245 Producer.MailLinkName=maillink.gif
 246
 247 # this is the name of the subdirectory where the image-dir
 248 # will be linked to.
 249 #
 250 Producer.ImageRoot=/img
 251
 252
 253
 254 ################################################
 255 ########### C) DYNAMIC SITE CONFIG #############
 256 ################################################
 257
 258 # the main mir-servlet
 259 #
 260 Producer.ActionServlet=/servlet/Mir
 261
 262 # the url of the openposting-servlet
 263 #
 264 Producer.OpenAction=http://mir.someserver.org/servlet/OpenMir
 265
 266 # the maximum allowed size of an uploaded media file in KB.
 267 #
 268 MaxMediaUploadSize=20000
 269
 270 # the maximum number of allowed media items to upload at once.
 271 #
 272 ServletModule.OpenIndy.MaxMediaUploadItems=20
 273
 274 # the default number of media items to upload at once
 275 #
 276 ServletModule.OpenIndy.DefaultMediaUploadItems=1
 277
 278
 279 ######################
 280 # PDF configurations #
 281 ######################
 282
 283 # the following lines are used to construct PDFs on the fly from one or more articles
 284 # for the moment, if you want to change anything else about your pdfs, you
 285 # will have to learn some java!
 286 #
 287 # keep in mind that there may not be enough room for all the text you enter as the
 288 # value of one these options, if text doesn't appear, the only easy thing to do is
 289 # use less text!
 290 #
 291
 292 # a single line of big text which will appear at the top of the first page of all generated pdfs
 293 #
 294 PDF.Title=SOME MIR-SITE
 295
 296 # about two lines of small text which will appear at the bottom of every page
 297 #
 298 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.
 299
 300 # the size paper your target audience will likely have in their printers.
 301 # pick one of A4 or LETTER
 302 #
 303 PDF.PageSize=A4
 304
 305 ################################################
 306 ############ D) DATABASE CONFIG   ##############
 307 ################################################
 308
 309 # specify your database
 310 #
 311 Database.Name=Mir
 312 Database.Username=postgres
 313 Database.Password=
 314
 315 Database.Host=localhost
 316 Database.Port=5432
 317 Database.Driver=org.postgresql.Driver
 318
 319
 320 ############################################
 321 # encoding configuration                   #
 322 ############################################
 323
 324 # The default encoding charset used in the written html files as well
 325 # as the dynamic output html.
 326 Mir.DefaultHTMLCharset=UTF-8
 327
 328 # The java equivalent of Mir.DefaultHTMLCharset
 329 Mir.DefaultEncoding=UTF8