Copy mir-setup to 1.1 branch
[mir.git] / scripts / mir-setup / conf / config.properties-default
diff --git a/scripts/mir-setup/conf/config.properties-default b/scripts/mir-setup/conf/config.properties-default
new file mode 100755 (executable)
index 0000000..e5dee0e
--- /dev/null
@@ -0,0 +1,331 @@
+# $Id: config.properties-default,v 1.1.2.1 2006/11/11 12:52:06 zak Exp $
+# Based on mir/etc/config.properties-dist 1.31.2.5
+#
+# 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 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 & admin setup
+# b) static site config
+# c) dynamic site
+# d) database config
+#
+# edit this to suit your needs
+# After editing this file, two steps need to be taken to make the changes effective:
+#   1. ant has to be invoked.
+#   2. tomcat needs to be restarted.
+#
+# This file only contains the properties that are most often changed. To view all
+# possible config values, refer to the file default.properties, located in the
+# source directory. Don't change settings in default.properties however, instead
+# use this file.
+#
+# Note: for filename values, by default, files are used relative to the servlet's
+# WEB-INF directory.
+#
+# The setup uses the following assumptions:
+# The URL to reach the site is http://mir.someserver.org
+# The StorageRoot of this URL is /var/www/project/site/
+# All produced pages and media are located below this directory.
+
+################################################
+############    A) GENERAL SETUP  ##############
+################################################
+
+# mir/project an contact information
+# for display on the site
+#
+Mir.Name=$FQDN
+Mir.Shortname=$SITE
+
+Mir.Contact-email.address=webmaster@$FQDN
+Mir.Contact-email.name=$FQDN webmaster
+
+Mir.Tech-email.address=webmaster@$FQDN
+Mir.Tech-email.name=$FQDN technical contact
+
+Mir.Public-email.address=webmaster@$FQDN
+Mir.Public-email.name=$FQDN public contact
+
+# 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= America/New_York
+
+# Default date/time format
+# For the syntax of the format, refer to
+# http://java.sun.com/j2se/1.3/docs/api/java/text/SimpleDateFormat.html
+Mir.DefaultDateTimeFormat = yyyy-MM-dd HH:mm
+
+# For missing values, the FallbackLanguage is used as default
+#
+Mir.Admin.FallbackLanguage=en
+
+#################################
+# 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
+
+# Show who's logged in?
+#
+Mir.Admin.ShowLoggedinUsers=1
+
+# enable deletion of comments/articles?
+#
+Mir.Localizer.Admin.AllowDeleteComment=1
+Mir.Localizer.Admin.AllowDeleteArticle=1
+
+#######################
+# automated producers #
+#######################
+
+# 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
+
+#########
+# rsync #
+#########
+
+#use rsync to mirror the website to a remote-host
+#
+Rsync=no
+Rsync.Script.Path=/var/www/bin/rsync-copy.sh
+
+
+###################
+# 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)> [, ....]
+#
+ServletModule.FileEdit.Configuration= \
+  includes:/var/www/project/site/includes:.*\\.inc:1
+
+################################################
+###########  B) STATIC SITE CONFIG #############
+################################################
+
+# the url of the static site
+# on the machine where mir runs on
+#
+Producer.ProductionHost=http://$FQDN
+
+# the url of the public site
+# only different from ProductionHost if pages are copied to
+# one ore more mirror-servers for delivery
+#
+Producer.PublicationHost=http://$MIRRORFQDN
+
+# Produrce.StorageRoot is the directory, in which
+# the generated HTML pages will be stored
+#
+Producer.StorageRoot=$PRODUCTIONDIR
+
+# 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=
+
+
+#####################
+# 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=/video
+
+# the url of the audio-server
+#
+Producer.Audio.Host=/audio
+
+# the url of the image-server
+#
+Producer.Image.Host=/images
+
+# the url of the media-server
+#
+Producer.Media.Host=/media
+
+# the url of the real-media-server
+#
+Producer.RealMedia.Host=rtsp://$MIRRORFQDN/real/
+
+
+
+############################################
+# image/media specific storage directories #
+############################################
+
+# absolute directory, where the images are saved
+#
+Producer.Image.Path=$PRODUCTIONDIR/images/
+
+
+# absolute directory, where the media files are saved
+#
+Producer.Media.Path=$PRODUCTIONDIR/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=$PRODUCTIONDIR/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
+
+# this is the name of the subdirectory where the image-dir
+# will be linked to.
+#
+Producer.ImageRoot=/img
+
+
+
+################################################
+########### C) DYNAMIC SITE CONFIG #############
+################################################
+
+# the main mir-servlet
+#
+Producer.ActionServlet=/servlet/Mir
+
+# the url of the openposting-servlet
+#
+Producer.OpenAction=https://$SECUREFQDN/$SITE/servlet/OpenMir
+
+# 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
+
+
+######################
+# 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!
+#
+# 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=$FQDN
+
+# 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
+
+################################################
+############ D) DATABASE CONFIG   ##############
+################################################
+
+# specify your database
+#
+Database.Name=$DBNAME
+Database.Username=$DBUSER
+Database.Password=$DBPASS
+
+Database.Host=localhost
+Database.Port=5432
+Database.Driver=org.postgresql.Driver
+
+
+############################################
+# encoding configuration                   #
+############################################
+
+# The default encoding charset used in the written html files as well
+# as the dynamic output html.
+Mir.DefaultHTMLCharset=UTF-8
+
+# The java equivalent of Mir.DefaultHTMLCharset
+Mir.DefaultEncoding=UTF8