big reorganisation, more examples and explanations, more clearly arranged
authorinit <init>
Tue, 2 Dec 2003 14:13:57 +0000 (14:13 +0000)
committerinit <init>
Tue, 2 Dec 2003 14:13:57 +0000 (14:13 +0000)
etc/config.properties-dist

index f8ab50e..0b16d91 100755 (executable)
@@ -1,22 +1,24 @@
 #
 # Sample config for Mir
 # by Matthias <mjordan@code-fu.de> 2001-09-12
+# reorganized by <init@nadir.org>  2003-02-12
 #
 # The Mir software realizes a semi-dynamic web service:
-# The web server that is accessed by users has pure static
+# The web server that is accessed by readers has pure static
 # pages. These pages are generated by the Mir software that
 # consists of a collection of Java servlets and HTML templates.
+#
 # Mir uses a database server to store the data that is needed to
 # build the static site.
 # So there are basically three parts in this config file:
 #
-# a) general setup
+# a) general & admin setup
 # b) static site config
-# c) dynamic admin site
+# c) dynamic site
 # d) database config
 #
 # edit this to suit your needs
-# After you edited this file, build.sh has to be invoked.
+# After you edited this file, "ant" has to be invoked.
 # To be sure, also restart Tomcat.
 #
 # Note that for Mir to work, Tomcat has to be set up to handle all
 # located in source/. If necessary these values can be overridden in this file.
 #
 # The setup uses the following assumptions:
-# The URL to reach the site is http://indy.code-fu.de
-# The StorageRoot of this URL is /pub/Dokumente/Indymedia/de-tech/Mir
-# All data is located below this directory, including the servlets.
+# The URL to reach the site is http://mir.code-fu.org
+# The StorageRoot of this URL is /var/www/project/site/
+# All produced pages and media are located below this directory.
+# The servlets are also found there in a /servlet subdir.
 
 
-#
-#
-# GENERAL SETUP
-#
+################################################
+############    A) GENERAL SETUP  ##############
+################################################
 
-### mir/imc information
-Mir.Name=mir.indymedia.org
+# mir/project an contact information
+# for display on the site
+#
+Mir.Name=mir.someserver.org
 Mir.Shortname=mir
-Mir.Contact-email.address=mir-coders@lists.indymedia.org
-Mir.Contact-email.name=mir-coders mailinglist
-Mir.Tech-email.address=mir-coders@lists.indymedia.org
-Mir.Tech-email.name=mir-coders mailinglist
-Mir.Public-email.address=mir-coders@lists.indymedia.org
-Mir.Public-email.name=mir-coders mailinglist
 
+Mir.Contact-email.address=mir-project@somemailserver.org
+Mir.Contact-email.name=mir-project mailinglist
+
+Mir.Tech-email.address=mir-admins@somemailserver.org
+Mir.Tech-email.name=mir-admins mailinglist
+
+Mir.Public-email.address=project@somemailserver.org
+Mir.Public-email.name=project mailinglist
+
+
+# DirectOpenposting
+# yes = articles appear in the newswire on the startpage directly after posting them
+# no  = new articles not in newswire by default
+#       and editors have to promote them before they show on startpage
+#
 DirectOpenposting=yes
 
 # Default timezone to display times in in admin, producers
+# use CET for Central European Time (Paris, Amsterdam)
+# more timezones here: http://www.postgresql.org/docs/7.2/static/timezones.html
+#
 Mir.DefaultTimezone= UTC
 
 # Default date/time format
+#
 Mir.DefaultDateTimeFormat = yyyy-MM-dd HH:mm
 
-#where to put the lucene index
-IndexPath=/tmp/index
+# where to put the lucene index
+# for the build in searchengine
+# (must be created by you and writable by tomcat-user)
+#
+IndexPath=/var/www/project/lucineindex
 
 # temp-dir used for media-uploads
+#
 TempDir=/tmp
 
+# Logging
+# by default logs are found in bin/mir/WEB-INF/log
+#
 Log.LogClass = mir.log.log4j.LoggerImpl
 Log.log4j.ConfigurationFile = etc/log4j.properties
 Log.Home = log
 
+# Mir.Localizer
+# for your additional site-specific java-code
+#
 Mir.Localizer=mircoders.localizer.basic.MirBasicLocalizer
 
 # The location of the producer specifiations
+#
 Mir.Localizer.ProducerConfigFile=etc/producer/producers.xml
 
+# For missing values, the FallbackLanguage is used as default
+#
+Mir.Admin.FallbackLanguage=en
+
+# the templates
+#
+Mir.Localizer.Producer.GeneratorLibrary= default=freemarker(etc/producer/)
+Mir.Localizer.Admin.GeneratorLibrary= default=freemarker(templates/admin/)
+Mir.Localizer.OpenPosting.GeneratorLibrary= default=freemarker(etc/open/)
+
+
+#################################
+# admin interface configuration #
+#################################
+
 # Settings for the admin login:
 # If the default language is left empty, it will set the accept-language of
 # the client browser as the default.
+#
 Mir.Login.DefaultLanguage=en
 Mir.Login.Languages=en;de;fr;nl;es;pt;eu;sv;tr;zh;gz
 
-# For missing values, the FallbackLanguage is used as default
-Mir.Admin.FallbackLanguage=en
-
 # Show who's logged in?
+#
 Mir.Admin.ShowLoggedinUsers=1
 
-# the templates
-Mir.Localizer.Producer.GeneratorLibrary= default=freemarker(etc/producer/)
-Mir.Localizer.Admin.GeneratorLibrary= default=freemarker(templates/admin/)
-Mir.Localizer.OpenPosting.GeneratorLibrary= default=freemarker(etc/open/)
-
 # How should the custom operations (hide etc) in article and comment lists
 # be presented?
 # 0 = links, 1 = checkboxes, 2 = a listbox
+#
 Mir.Localizer.Admin.ListOperationsFlavor=1
 
 # How should the topics be presented on the article edit page?
 # 0 = in a multiselect list box, 1 = checkboxes
+#
 Mir.Localizer.Admin.TopicListFlavor=1
 
 # For the checkboxes flavour, how many columns should there be?
+#
 Mir.Localizer.Admin.TopicListColumns=3
 
 # In which order should the topic appear?
+#
 Mir.Localizer.Admin.TopicListOrder=title
 
 # enable deletion of comments/articles?
+#
 Mir.Localizer.Admin.AllowDeleteComment=1
 Mir.Localizer.Admin.AllowDeleteArticle=1
 
-
 # Article Preview Link URL (Link to produced articles from within admin)
-Comment.PublicUrl=http://production.indy.code-foo.org/en/${date.formatted.yyyy}/${date.formatted.MM}/${id}.shtml
-Article.PublicUrl=http://production.indy.code-foo.org/en/${to_content.date.formatted.yyyy}/${to_content.date.formatted.MM}/${to_content.id}.shtml
+#
+Article.PublicUrl=http://mir.code-foo.org/en/${to_content.date.formatted.yyyy}/${to_content.date.formatted.MM}/${to_content.id}.shtml
+Comment.PublicUrl=http://mir.code-foo.org/en/${date.formatted.yyyy}/${date.formatted.MM}/${id}.shtml
+
 
+#######################
+# automated producers #
+#######################
 
-# Which producers need to be called after an article (resp. a comment) is posted
-Mir.Localizer.OpenPosting.ContentProducers= media.new;articles.changed;startpage.generate;synchronization.run
-Mir.Localizer.OpenPosting.CommentProducers= articles.changed;synchronization.run
+# Which producers need to be called after an article is posted
+#
+Mir.Localizer.OpenPosting.ContentProducers= \
+media.new;articles.changed;startpage.generate;synchronization.run
+
+# Which producers need to be called after a comment is posted
+#
+Mir.Localizer.OpenPosting.CommentProducers= \
+articles.changed;synchronization.run
 
 # Which producers need to be called after the "produce all new" link is clicked from admin
-Mir.Localizer.Producer.AllNewProducers= media.new;articles.changed;startpage.run;synchronization.run
+#
+Mir.Localizer.Producer.AllNewProducers= \
+media.new;articles.changed;startpage.run;synchronization.run
+
+#########
+# rsync #
+#########
 
 #use rsync to mirror the website to a remote-host
+#
 Rsync=no
-Rsync.Script.Path=/var/www/bin/rsync-copy
+Rsync.Script.Path=/var/www/bin/rsync-copy.sh
 
-# the maximum allowed size of an uploaded media file in KB.
-MaxMediaUploadSize=20000
-
-# the maximum number of allowed media items to upload at once.
-ServletModule.OpenIndy.MaxMediaUploadItems=20
-
-# the default number of media items to upload at once
-ServletModule.OpenIndy.DefaultMediaUploadItems=1
 
+###################
+# FileEdit module #
+###################
 
+# for extra flexibility editors can edit text-files from within the admin-interface
+# these files can then be included in webpages using SSI as footer or announcement-box...
 #
+# a list of directories to edit
+# format:
+#      <name>:<path>:<file filter>:<0|1 (recursion off or on)> [, ....]
 #
-# STATIC SITE CONFIG
-#
+ServletModule.FileEdit.Configuration= \
+  includes:/var/www/project/site/includes:.*\\.inc:1
 
-# the url of the static site
-Producer.ProductionHost=http://indy.code-fu.de
 
-# the url of the public site
-Producer.PublicationHost=http://indy.code-fu.de
 
-# Produrce.StorageRoot is the directory, in which
-# the generated HTML pages will be stored
-Producer.StorageRoot=/pub/Dokumente/Indymedia/de-tech/Mir/produced
-
-# FileEdit module
-#   a list of directories to edit
-#   format:
-#      <name>:<path>:<file filter>:<0|1 (recursion off or on)> [, ....]
-ServletModule.FileEdit.Configuration= \
-  includes:/pub/Dokumente/Indymedia/de-tech/Mir/produced/inc:.*\\.inc:1
 
+################################################
+###########  B) STATIC SITE CONFIG #############
+################################################
 
+# the url of the static site
+# on the machine where mir runs on
 #
+Producer.ProductionHost=http://mir.code-fu.org
+
+# the url of the public site
+# only different from ProductionHost if pages are copied to
+# one ore more mirror-servers for delivery
 #
-# DYNAMIC SITE CONFIG
-#
+Producer.PublicationHost=http://mir.code-fu.org
 
-# the url of the openposting-servlet
-Producer.OpenAction=http://indy.code-fu.de/Mir/servlet/OpenMir
+# Produrce.StorageRoot is the directory, in which
+# the generated HTML pages will be stored
+#
+Producer.StorageRoot=/var/www/project/site/
 
-# use this property if the pages are not produced under the docRoot
+# use this property only if the pages are NOT produced under the docRoot
 # of the webserver. all links in the produced pages are prepended
 # with Producer.DocRoot
+#
 Producer.DocRoot=
 
-Producer.ActionServlet=/servlet/Mir
 
-# this is the name of the subdirectory where the image-dir
-# will be linked to.
-Producer.ImageRoot=/img
+#####################
+# media server URLs #
+#####################
 
+# for better performance or load-sharing
+# images/media can be copied to (and served from) different servers
+# only in this case image- and medialinks need different URLs.
 
 # the url of the video-server
-Producer.Video.Host=http://indy.code-fu.de/video
+#
+Producer.Video.Host=http://mir.code-fu.org/video
 
 # the url of the audio-server
-Producer.Audio.Host=http://indy.code-fu.de/audio
+#
+Producer.Audio.Host=http://mir.code-fu.org/audio
 
 # the url of the image-server
-Producer.Image.Host=http://indy.code-fu.de/images
+#
+Producer.Image.Host=http://mir.code-fu.org/images
 
 # the url of the media-server
-Producer.Media.Host=http://indy.code-fu.de/media
+#
+Producer.Media.Host=http://mir.code-fu.org/media
 
 # the url of the real-media-server
-Producer.RealMedia.Host=rtsp://some.media.server/somedir/
+#
+Producer.RealMedia.Host=rtsp://some.streamingmedia.server/somedir/
+
 
 
-# image specific storage directories
+############################################
+# image/media specific storage directories #
+############################################
+
 # absolute directory, where the images are saved
-Producer.Image.Path=/pub/Dokumente/Indymedia/de-tech/Mir/produced/images/
+#
+Producer.Image.Path=/var/www/project/site/images/
+
 
-# media specific storage directories
 # absolute directory, where the media files are saved
-Producer.Media.Path=/pub/Dokumente/Indymedia/de-tech/Mir/produced/media
+#
+Producer.Media.Path=/var/www/project/site/media
 
 # absolute directory, where the realmedia data files(ra and rm) are saved
 # the ram files which point to the RealMedia.Host get saved in the regular Media dir
 # this should make rsyncing to a separate streaming server much easier
-Producer.RealMedia.Path=/pub/Dokumente/rtsp
+#
+Producer.RealMedia.Path=/var/www/project/site/rtsp
 
+# mir creates a small thumbnail-icon for each image posted
 # relativ directory, where the thumbnails will be saved
+#
 Producer.Image.IconPath=/icon
 
+
+####################
+# media-type-icons #
+####################
+
+# by default they are stored in the webservers [docRoot]/img directory
+# they are distibuted with the mir-source (etc/producer/images)
+# use the "staticimages.generate" producer once to copy them in place
+#
+
 # Tiny Icons for the media types on the newswire summary.
 # (right hand side of start page)
+#
 Producer.Icon.TinyImage=photo_small.gif
 Producer.Icon.TinyAudio=audio_small.gif
 Producer.Icon.TinyVideo=video_small.gif
 Producer.Icon.TinyText=text_small.gif
 
 #Medium sized icons used at various places
+#
 Producer.Icon.BigImage=photo_big.gif
 Producer.Icon.BigAudio=audio_big.gif
 Producer.Icon.BigVideo=video_big.gif
 Producer.Icon.BigText=text_big.gif
 
 #Icons used for links
+#
 Producer.ExtLinkName=extlink.gif
 Producer.IntLinkName=intlink.gif
 Producer.MailLinkName=maillink.gif
 
-#the style sheet used to turn html into xsl:fo
-#this is not currently in use, so don't worry about it
-Producer.HTML2FOStyleSheet=/some/dir/mir/etc/producer/html2fo.xsl 
-
-# the following lines are used to construct PDFs on the fly from one or more articles
-# for the moment, if you want to change anything else about your pdfs, you 
-# will have to learn some java!
-#
-# keep in mind that there may not be enough room for all the text you enter as the 
-# value of one these options, if text doesn't appear, the only easy thing to do is 
-# use less text!
+# this is the name of the subdirectory where the image-dir
+# will be linked to.
 #
+Producer.ImageRoot=/img
 
-# a single line of big text which will appear at the top of the first page of all generated pdfs
 
-PDF.Title=INDYMEDIA SOMEWHERE
 
-# about two lines of small text which will appear at the bottom of every page 
+################################################
+########### C) DYNAMIC SITE CONFIG #############
+################################################
 
-PDF.Footer=Indymedia does blah.  Content is good, and free to use for non-commercial purposes under the Open Content license. if you have questions, email someone.
+# the main mir-servlet
 #
-# the size paper your target audience will likely have in their printers.  pick one of A4 or LETTER
+Producer.ActionServlet=/servlet/Mir
+
+# the url of the openposting-servlet
 #
+Producer.OpenAction=http://mir.code-fu.org/servlet/OpenMir
 
-PDF.PageSize=A4
+# the maximum allowed size of an uploaded media file in KB.
+#
+MaxMediaUploadSize=20000
 
+# the maximum number of allowed media items to upload at once.
 #
-# edit with caution below this line
-######################################################################
+ServletModule.OpenIndy.MaxMediaUploadItems=20
 
+# the default number of media items to upload at once
 #
+ServletModule.OpenIndy.DefaultMediaUploadItems=1
+
+
+
+######################
+# PDF configurations #
+######################
+
+# the following lines are used to construct PDFs on the fly from one or more articles
+# for the moment, if you want to change anything else about your pdfs, you
+# will have to learn some java!
 #
-# DATABASE SETUP
+# keep in mind that there may not be enough room for all the text you enter as the
+# value of one these options, if text doesn't appear, the only easy thing to do is
+# use less text!
 #
 
+# a single line of big text which will appear at the top of the first page of all generated pdfs
 #
+PDF.Title=SOME MIR-SITE
+
+# about two lines of small text which will appear at the bottom of every page
+#
+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.
+
+# the size paper your target audience will likely have in their printers.
+# pick one of A4 or LETTER
+#
+PDF.PageSize=A4
+
+
+#the style sheet used to turn html into xsl:fo
+#this is not currently in use, so don't worry about it
+Producer.HTML2FOStyleSheet=/some/dir/mir/etc/producer/html2fo.xsl
+
+
+
+######################################################################
+#  edit with caution below this line
+######################################################################
+
+################################################
+############ D) DATABASE CONFIG   ##############
+################################################
+
 # specify your database
+#
+Database.Name=Mir
+Database.Username=postgres
+Database.Password=
+
+Database.Host=localhost
+Database.Port=5432
 
 Database.poolMin=1
 Database.poolMax=10
 Database.poolResetTime=1.0
 Database.PoolLog=log/pool.log
 Database.Limit=20
-Database.Username=postgres
-Database.Password=
-Database.Host=localhost
-Database.Name=Mir
-Database.Port=5432
 Database.Driver=org.postgresql.Driver
 
 
-#
-# Servlet / Module configurations
-#
+
+############################################
+# servlet / module encoding configurations #
+############################################
 
 # don't change this unless you really know your i18n.
 # The default encoding charset used in the written html files as well
 # as the dynamic output html.
 # also used for the HTML charset meta tag.
+#
 Mir.DefaultEncoding=UTF8
 
 # this encoding is used for the HTML charset meta tag.
 # it must be the html charset equivalent of the Java encoding above
 # don't change this unless...
+#
 Mir.DefaultHTMLCharset=UTF-8