jspwiki

Upload: abmel-salim-lopessier

Post on 06-Apr-2018

218 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/2/2019 jspwiki

    1/21

    ############################################################################# This is the JSPWiki configuration file. You'll need to edit this# a bit. The first few lines are the most important ones.## Wherever it is said that an option can be "true" or "false", youcan# also use "yes"/"no", or "on/off". Just for some convenience.### You can use this to override the default application name. Itaffects# the HTML titles and logging, for example. It can be different from# the actual web name (http://my.com/mywiki) of the application, butusually# it is the same.#

    jspwiki.applicationName = JSPWiki

    ## Describe where your wiki lives (the real URL through which it isavailable# through the internet/intranet). This is a mandatory attribute.## Be careful if you use a localhost address (http://localhost/ orhttp://127.0.0.1/),# as this will cause some unwanted side effects if your wiki isaccessed from# any other computer than where the wiki is running.## Example:# jspwiki.baseURL = http://www.jspwiki.org/#jspwiki.baseURL=

    ## Which page provider class to use. Possibilities are:## RCSFileProvider - for simple RCS-based file storage# FileSystemProvider - for simple pure file storage with noversion information# VersioningFileProvider - for simple, non-RCS based versioningstorage.## Note that if you're upgrading from JSPWiki 1.x, then you need toremove the# "com.ecyrd.jspwiki." part from the beginning of the path.#jspwiki.pageProvider = FileSystemProvider

    #

  • 8/2/2019 jspwiki

    2/21

    # How to order pages in various lists and plugins. By default, theyare# ordered using Java's "natural" String order (purely character bycharacter# comparison). This means that the pages named "Page1", "Page2" and"Page10"# appear in the order "Page1", "Page10", "Page2".## To specify a different ordering, give the fully qualified name of aString# Comparator. If the class can't be found, an error will be logged andpage# sorting will fall back to the default "natural" ordering. You canspecify# any String Comparator class here BUT be careful of using caseinsensitive# comparators as JSPWiki page names may be case sensitive.# Example: jspwiki.pageNameComparator.class =

    my.fully.qualified.comparator## For convenience, we have provided a few possibly useful comparators:## HumanComparator understands numbers and sorts in a more humanfriendly# order (English only). Using HumanComparator, the pages "Page1","Page2",# "Page10" will sort in that order.# Example: jspwiki.pageNameComparator.class = HumanComparator## LocaleComparator uses the server's Locale for ordering. Useful ifyour# content is always in a language other than English. Does not dohuman# friendly numeric ordering.# Example: jspwiki.pageNameComparator.class = LocaleComparator##jspwiki.pageNameComparator.class =

    ## Set to true, if you want to cache page data into memory. This is# in general a good idea.## Default is false (no cache).## NB: This replaces the JSPWiki 1.x "CachingProvider" setting, sinceit# probably was too confusing.#jspwiki.usePageCache = true

    ## Determines where wiki files are kept for FileSystemProvider

  • 8/2/2019 jspwiki

    3/21

    # and RCSFileProvider## If you're using Windows, then you must duplicate the backslashes.# For example, use:## jspwiki.fileSystemProvider.pageDir = C:\\Data\\jspwiki#jspwiki.fileSystemProvider.pageDir = /p/web/www-data/jspwiki/

    ## The JSPWiki working directory. If not set, a temporary path will# be used. You can see the location of the workdir in the logs.# It is HIGHLY recommended that you set this.## The working directory is used to cache things like Lucene search# results.##jspwiki.workDir =

    ## ATTACHMENTS:## Use the following property to define which attachment provider# you want to use. You have basically two choices:# * Set the value to BasicAttachmentProvider# a simple, flat file versioning provider# * Leave the value empty (or just comment the line out)# the attachment functionality is disabled#jspwiki.attachmentProvider = BasicAttachmentProvider

    ## The BasicAttachmentProvider needs to know where to store the files# the user has uploaded. It's okay to put these in the samedirectory# as you put your text files (i.e. the pageDir setting above).## If you're using Windows, then you must duplicate the backslashes.# For example, use:## jspwiki.basicAttachmentProvider.storageDir = C:\\Data\\jspwiki#jspwiki.basicAttachmentProvider.storageDir = /p/web/www-data/jspwiki/

    ## You can tell the BasicAttachmentProvider to add a flag# so that browsers do not cache certain (or all) attachment# types. This is useful in intranet environments. You should activate# this if your users complain that their excel files are not uploaded# correctly and they still do have an old version: Usually the# file was uploaded correctly, but they get the locally cachedversion

  • 8/2/2019 jspwiki

    4/21

    ## You can use regular expressions to disable the cache, e.g the# following example will disable browser cache for all excel and wordfiles## If you don't define this property, cache is enabled by default for# all attachments## jspwiki.basicAttachmentProvider.disableCache = .*\.xls|.*\.doc

    ## You can limit the maximum size of an attachment by setting this# value. The value is in bytes, and by default all attachments# are accepted.# This limit is not enforced for users with AdminPermissions.## The following line would limit the attachment size to 100,000 bytes#jspwiki.attachment.maxsize=100000

    ## By default JSPWiki accepts all types of attachments. However, you# can allow some types only, or forbid some other types. By default,# all file types are allowed (if you do not specify the "allow" list# at all or it is empty).# These allow/forbid statements are not enforced for users withAdminPermissions.## These both are space-separated lists of file suffixes## Example: Allow only PNG, JPG, ZIP and JAR file attachments#jspwiki.attachment.allow=.png .jpg .zip .jar

    # Example: Forbid HTML, PHP, ASP and EXE#jspwiki.attachment.forbid=.html .htm .php .asp .exe

    ## page Diff Representation## To show differences between page versions, you can define a# difference provider.# The following choices are available:# * TraditionalDiffProvider - Uses internal (java) diff# to create a list of changes and shows it line by# line colored. This is the default# * ContextualDiffProvider - Uses internal (java) diff# to create changes inline and shows it on a word by# word basis using CSS. This is much superior to the# traditional diff provider, however, it is still quite# new and not much tested. YMMV.# * ExternalDiffProvider - uses a system diff program (which# can be configured using "jspwiki.diffCommand") to# create an unified (!) diff.

  • 8/2/2019 jspwiki

    5/21

    ## Example for a diff command:# jspwiki.diffCommand = /usr/bin/diff -u %s1 %s2#jspwiki.diffProvider = TraditionalDiffProvider

    # Determines if you need to have relative urls or not. If thebaseURL# is not set, then this has no effect, but if you set the baseURL(which# is highly recommended), you can use this to set relative urls.## Possible values are "absolute" and "relative".##jspwiki.referenceStyle=relative

    ## Determines which character encoding JSPWiki should use. If you

    want# to support all languages in your Wiki, you probably want to enable# this. From JSPWiki 2.2, it is strongly suggested that you use UTF-8.## Note that you can't switch these in the mean time, since the waythe# files are encoded on disk is incompatible between ISO-Latin1 andUTF-8.# Don't try. You'll get all sorts of interesting problems, if youdo.## Possible values are 'ISO-8859-1' (default, if none has beenspecified)# and 'UTF-8'.

    jspwiki.encoding = UTF-8

    ## Determines whether raw HTML is allowed as Wiki input.## THIS IS A DANGEROUS OPTION!## If you decide to allow raw HTML, understand that ANY person who has# access to your Wiki site can embed ANY sort of maliciousJavaScript,# or plugin, or ActiveX, or whatever on your site. They can evenmess it# up so royally it is impossible for you to replace the situationwithout# the need of direct access to the repository. So think twice before# allowing raw HTML on your own site.#

  • 8/2/2019 jspwiki

    6/21

    # Most probably you want to use this on Intranets, or personalservers,# where only a handful of people can access the wiki.## Text between {{{ and }}} -options is not affected by this setting,so# it's always safe to quote HTML code with those.## The default for this option is "false".#jspwiki.translatorReader.allowHTML = true

    ############################################################################## Usability niceties.##

    # If this property is set to "true", then page titles are rendered# using an extra space between every capital letter. It may make# page titles readable on some occasions, but it does have the# drawback of making the titles look a bit funny at times.#jspwiki.breakTitleWithSpaces = false

    ## If set to true, this property means that "WikiName" and "WikiNames"# are considered equal when linking between them. Setting this to# true does not prevent you from having both kinds of pages - we just# fall back to the other one if the primary name does not exist.## For any other language, you'll probably want to turn this off.#jspwiki.translatorReader.matchEnglishPlurals = true

    ## If you set this to true, the Wiki translator will then alsoconsider# "traditional" WikiNames (that is, names of pagesJustSmashedTogether# without square brackets) as hyperlinks. This technique is also# known as "CamelCase", or "BumpyCase", or "InterCapping". Ipersonally# like CamelCase as a word, which is why this property is named as itis :-).## By default this is false, since traditional WikiLinks may confusenewbies.## This option can be overridden on a per-page basis using the SETdirective.#

  • 8/2/2019 jspwiki

    7/21

    jspwiki.translatorReader.camelCaseLinks = false

    ## This sets the default template used by the Wiki engine. Thetemplates# live in templates/. JSPWiki will attempt to findthree# basic templates from that directory: "ViewTemplate," "EditTemplate"# and "AdminTemplate"## By default this is called "default".## This option can be overridden on a per-page basis using the SETdirective.#jspwiki.templateDir = default

    ## The name of the front page. This is the page that gets loaded ifno# other page is loaded. Up until JSPWiki 1.9.28, it was alwayscalled# "Main", but now you can easily change the default front page here.If not# defined, uses "Main".##jspwiki.frontPage = Main

    ## Allow creation of empty pages. Defaults to false.##jspwiki.allowCreationOfEmptyPages = false

    ## If set to true, all outward links have a small icon attached. Theicon# can be found from images/out.png. Default is true.#jspwiki.translatorReader.useOutlinkImage = true

    ## Set this to the number of minutes a person can "lock" a page# for while he is editing it.#jspwiki.lockExpiryTime = 60

    ## Search provider used for searching pages and attachments.# Default is LuceneSearchProvider, but you can fall back toBasicSearchProvider#

  • 8/2/2019 jspwiki

    8/21

    jspwiki.searchProvider = LuceneSearchProvider

    ## If your wiki's language is something else than English, you might# want to visit jakarta.apache.org/lucene and download a properAnalyzer# for your language. Default is to use StandardAnalyzer.##jspwiki.lucene.analyzer =org.apache.lucene.analysis.standard.StandardAnalyzer

    ############################################################################## Special page references.## The URL is relative to Wiki.jsp. However, if you use# a full, absolute URL, you can also do that.

    ## Example to redirect all requests to a page called 'OriginalWiki'# to the original wikiwiki at http://c2.com/cgi/wiki## jspwiki.specialPage.OriginalWiki = http://c2.com/cgi/wiki## Note that it is entirely possible to override any Wiki page, even# an existing one by redefining it here.#jspwiki.specialPage.CreateGroup = NewGroup.jsp#jspwiki.specialPage.FindPage = Search.jspjspwiki.specialPage.Search = Search.jspjspwiki.specialPage.Login = Login.jspjspwiki.specialPage.NewGroup = NewGroup.jspjspwiki.specialPage.UserPreferences = UserPreferences.jspjspwiki.specialPage.Workflow = Workflow.jsp

    ############################################################################### Plugin search paths.## Define here the packages you want to use for searching plugins,# separated with commas.# For example, use the following command to add"org.myorganisation.jspwiki.myplugins"# and "com.foobar.myplugins" to the search path.## jspwiki.plugin.searchPath =org.myorganisation.jspwiki.myplugins,com.foobar.myplugins## The default path is "com.ecyrd.jspwiki.plugin", and it will bealways

  • 8/2/2019 jspwiki

    9/21

    # the last item on the path. This allows you to override JSPWikidefault# plugins. Note that you are only adding to the path, not replacingit (ie.# the default path is never removed.)## If the path is not specified (and there is no jspwiki_module.xmlwith the# plugin JAR), you need to either declare the search path by hand, or# use a fully qualified name.## If you are a plugin developer, please consider deploying ajspwiki_module.xml# file with your plugin JAR, so that the user does not have to setthe searchPath.## jspwiki.plugin.searchPath =org.myorganisation.jspwiki.myplugins,com.foobar.myplugins

    #jspwiki.plugin.searchPath =

    ############################################################################### Page filters## Normally, the filter configuration is in your WEB-INF/ directory,so you# do not need to go and specify this. However, if your filters.xmllive somewhere# else, you'll have to specify it here.##jspwiki.filterConfig = /some/path/to/your/filters.xml

    ############################################################################### URL Constructor## JSPWiki by default generates page and attachment links that use JSP# pages and request parameters. It can also use alternative URL# constructors so that URL pages resemble traditional website paths,too.# You have three choices for generating URLs:## DefaultURLConstructor - uses JSPs for all references:# http://mywiki.com/jspwiki/Wiki.jsp?page=Main# http://mywiki.com/jspwiki/Edit.jsp?page=Main## ShortURLConstructor - uses path-like reference style:# http://mywiki.com/jspwiki/wiki/Main# http://mywiki.com/jspwiki/wiki/Main?do=Edit

  • 8/2/2019 jspwiki

    10/21

    ## ShortViewURLConstructor - uses path-like references for views;JSPs for everything else:# http://mywiki.com/jspwiki/wiki/Main# http://mywiki.com/jspwiki/Edit.jsp?page=Main## Of course, you can also write your own implementation if you wish.## For either of the ShortURL constructors, you can also specify a# prefix path to go in front of page names. By default, the# prefix is 'wiki/'.## Be warned that the ShortURLConstructor does not work well with anyother editor# except the built-in plaintext one. Use ShortViewURLConstructor ifyou plan# to enable any other ones.#

    #jspwiki.urlConstructor = DefaultURLConstructor#jspwiki.urlConstructor = ShortViewURLConstructor#jspwiki.shortURLConstructor.prefix = wiki/

    ############################################################################### Rendering## At this time, entries here are strictly for development and testing.#

    # Disable internal caching of pre-constructed document DOMs.# This may be necessary if you require custom rendering that must notbe cached.#jspwiki.renderingManager.useCache = false

    ############################################################################### Security, authentication and authorization#

    # JSPWiki supports a plugin-based interface for talking to different# kinds of authentication and authorization systems. By"authentication,"# we mean a system for logging in a user to establish their identity.# By "authorization," we mean a system for figuring out what actions# users can perform based on their authenticated identities.## For users looking to get started quickly, the default settingsbelow# should work fine. In addition to the properties below, you may also

  • 8/2/2019 jspwiki

    11/21

    # want to modify the security policy file WEB-INF/jspwiki.policy. See# the policy file for more details.## AUTHENTICATION## For authentication, JSPWiki uses JAAS (Java Authentication andAuthorization# Service) in combination with a servlet filter that picks up anycredentials# set by the servlet container. The Authentication system isconfigured below.## You must choose either (A) Container or (B) Custom authentication.(B) is the default.## A) CONTAINER AUTHENTICATION# JSPWiki will always (passively) collect credentials supplied byyour servlet

    # container, via HttpServletRequest.getUserPrincipal/getRemote user.You do not# need to do anything to enable this. In addition, you can causeJSPWiki users# to log in to the web container by uncommenting the the # elements in WEB-INF/web.xml.## B) CUSTOM AUTHENTICATION# If you do not wish to use container-managed authentication, you canuse JSPWiki's# own custom authentication system. This uses a JAAS LoginModule(supplied below)# to log in the user. You can use any JAAS LoginModule you want.# The default class iscom.ecyrd.jspwiki.auth.login.UserDatabaseLoginModule,# which compares the supplied username and hashed password with thevalues stored# in the configured UserDatabase (see USER DATABASE below).## Supply the JAAS LoginModule class used for custom authenticationhere.# The implementation MUST have a zero-argument constructor (as notedin the# javax.security.auth.spi.LoginModule Javadocs).jspwiki.loginModule.class =com.ecyrd.jspwiki.auth.login.UserDatabaseLoginModule

    ## JAAS LoginContext parameters used to initialize the LoginModule.Note that 'param1'# etc. should be replaced with the actual parameter names. Theparameter names and

  • 8/2/2019 jspwiki

    12/21

    # values will be loaded to a Map and passed to the LoginModule as the'options' parameter# when its initialize() method is called. The defaultUserDatabaseLoginModule class does# not need any options.#jspwiki.loginModule.options.param1 = value1#jspwiki.loginModule.options.param2 = value2

    ## Cookie authentication & assertion## If this value is set to "true", then JSPWiki will allow you to"assert" an# identity using a cookie. It's still considered to be unsafe, justlike no# login at all, but it is useful when you have no need to forceeveryone to login.#

    # By default, this is on.##jspwiki.cookieAssertions=true

    ## If you would like to keep your users logged in for weeks at a time,you can# turn on "cookie authentication" feature. However, this comes withimportant# security caveats:# 1) User will stay logged in into your system for weeks. This meansthat if# someone manages to nab the cookie during this time, they canpretend to# be that user.# 2) The mappings between cookies and users are written in yourfilesystem,# in $jspwiki.workDir/logincookies. Access to this directorymeans that# the ability to fake anyone in the wiki, so please make sure thatonly# the proper admin has read access to this directory.## By default, cookie authentication is off.##jspwiki.cookieAuthentication=false

    ## Defines how many days the cookies are kept, and how often thepeople have to log in.# The default is two weeks, i.e. 14 days. If you need a shorterperiod than one day,# turn off cookie authentication, then tweak your web.xml to allowfor longer sessions.

  • 8/2/2019 jspwiki

    13/21

    ##jspwiki.cookieAuthentication.expiry=14

    ### AUTHORIZATION## For authorization, JSPWiki has a two-tier system. When we want to# determine whether a user has permission to perform a certainaction,# we first consult (A) an external "authorizer" to determine if theuser# is a member of the required role. In addition to checking itsexternal# authorizer, it also checks (B) its GroupManager for wiki-managedgroups.## A) EXTERNAL AUTHORIZATION

    # By default, JSPWiki uses the servlet container's authorizationservice# for to check what roles the user belongs to (that is, it calls# HttpServletRequest.isUserInRole(String)). After the userauthenticates,# the default Authorizer (WebContainerAuthorizer) checks to see ifthe user# belongs to the roles listed in web.xml using / or# / elements. However, you can useanother# Authorizer if you wish; specify that class here.

    jspwiki.authorizer =com.ecyrd.jspwiki.auth.authorize.WebContainerAuthorizer

    # B) GROUPS# As an additional source of authorization, users can belong todiscretionary# "wiki groups" that the users manage themselves. Wiki groups arestored in a# GroupDatabase. The default group database uses an XML file forpersistent# storage. Override with your own GroupDatabase implementation withthis property:

    jspwiki.groupdatabase =com.ecyrd.jspwiki.auth.authorize.XMLGroupDatabase

    # The default group database implementation stores member lists# in an XML file. The location of this file should be in a securedirectory# in the filesystem; for example, in /etc or your servlet container's

  • 8/2/2019 jspwiki

    14/21

    # configuration directory If you do not supply a value for thisproperty,# a blank group database will be initialized in the WEB-INF/directory of the# deployed webapp. Since these directories are often overwritten whenwebapps# are undeployed or redeployed, you should probably set this propertyto# something useful as soon as you can. But for test wikis, it'sprobably# ok to leave this un-set, as long as users know that their groupscould# "disappear" if the wiki app is ever redeployed.

    #jspwiki.xmlGroupDatabaseFile = /etc/tomcat/groupdatabase.xml

    # USER DATABASE# User's wiki profiles are stored in a UserDatabase. The default user

    database# uses an XML file for persistent storage.# Override with your own UserDatabase implementation with thisproperty:

    jspwiki.userdatabase = com.ecyrd.jspwiki.auth.user.XMLUserDatabase

    # The default user database implementation stores usernames andpasswords# in an XML file. Passwords are SHA-1 hashed. The location of thisfile# should be in a secure directory in the filesystem; for example, in# /etc or your servlet container's configuration directory.# If you do not supply a value for this property, a blank userdatabase# will be initialized in the WEB-INF/ directory of the deployedwebapp.# Since these directories are often overwritten when webapps are# undeployed or redeployed, you should probably set this property to# something useful as soon as you can. But for test wikis, it'sprobably# ok to leave this un-set, as long as users know that their profilescould# "disappear" if the wiki app is ever redeployed.

    #jspwiki.xmlUserDatabaseFile = /etc/tomcat/userdatabase.xml

    # You can also use a JDBC database for storing user profiles.# See the online AuthenticationAndAuthorization2.3 docs for details on# how to configure it.

    #jspwiki.userdatabase = com.ecyrd.jspwiki.auth.user.JDBCUserDatabase

    # If your JSPWiki user database shares login information with your

  • 8/2/2019 jspwiki

    15/21

    # web container's authentication realm, you can configure JSPWiki to# add container users. At present, this only works withJDBCUserDatabase,# and only if you've configured your web container to use a database# with compatible columns and tables. If you don't know what thismeans,# then leave this property set to FALSE (the default).

    #jspwiki.userdatabase.isSharedWithContainer = false

    # ACCESS CONTROL LISTS# Last but not least, JSPWiki needs a way of reading and persistingpage# access control lists. The default implementation reads these fromthe page# markup. For example: "[{ALLOW edit Charlie}]". If using a custom# ACL manager, specify the AclManager implementation class here:

    jspwiki.aclManager = com.ecyrd.jspwiki.auth.acl.DefaultAclManager

    ############################################################################### InterWiki links## The %s is replaced with the page reference (specify# multiple times to get multiple references). Page references should# appear in format : [wiki:wikipage].## This is the JSPWiki home. In future, JSPWiki will probably rely onthis# for error messages, so I don't recommend that you change it.jspwiki.interWikiRef.JSPWiki = http://www.jspwiki.org/wiki/%s

    # Here's how you can have directly links to the JSPWiki editor.# Now you can put a hyperlink for editing "MainPage" by making# a link [Edit:MainPage].jspwiki.interWikiRef.Edit = Edit.jsp?page=%s

    # This is the original WikiWikiWebjspwiki.interWikiRef.WikiWikiWeb = http://c2.com/cgi/wiki?%s

    # TWiki, a very nice WikiClone.jspwiki.interWikiRef.TWiki = http://twiki.org/cgi-bin/view/TWiki/%s

    # MeatballWiki, which seems to be quite popular.jspwiki.interWikiRef.MeatballWiki = http://usemod.com/cgi-bin/mb.pl?%s

    # Wikipedia, a Wiki encyclopedia!jspwiki.interWikiRef.Wikipedia = http://www.wikipedia.com/wiki/%s

    # Google, the ubiquitous search engine.

  • 8/2/2019 jspwiki

    16/21

    jspwiki.interWikiRef.Google = http://www.google.com/search?q=%s

    # JSPWiki documentation (for this release)jspwiki.interWikiRef.Doc = http://doc.jspwiki.org/2.8/wiki/%s

    ############################################################################## Define which image types are inlined.# These are your standard glob expressions (just like in your# Windows or UNIX shells). Default pattern is to include all PNG# images. If you specify something here, you will override thedefault.## Don't forget to increase the number after the dot - duplicateentries# cause problems!#

    # For example:# Inline all JPG files, PNG files and all files from images.com:## jspwiki.translatorReader.inlinePattern.1 = *.jpg# jspwiki.translatorReader.inlinePattern.2 = *.png# jspwiki.translatorReader.inlinePattern.3 = http://images.com/*

    ############################################################################# Determine how the RSS (Rich Site Summary) file generation shouldwork.# RSS is a standard pioneered by Netscape, which allows you to joinyour# Wiki with a huge number of different news services around theworld.# Try a Google search on RSS and see what you can do with it.## All of these settings were added in JSPWiki 1.7.6.## Note that jspwiki.baseURL MUST BE DEFINED if you want to enableRSS!## Determine if the RSS file should be generated at all. Allowedvalues# are "true" and "false". Default is "false".#jspwiki.rss.generate = false

    ## Determine the name of the RSS file. This path is relative to your# Wiki root. Default is "rss.rdf"#

  • 8/2/2019 jspwiki

    17/21

    jspwiki.rss.fileName = rss.rdf

    ## Determine the refresh interval (ie. how often the RSS file isregenerated.# It is not recommended to make this too often, or you'll choke yourserver.# Anything above five minutes is probably okay. The default value isone hour.# The value should be in seconds.#jspwiki.rss.interval = 3600

    ## The text you want to be shown as your "channel description" whensomeone# subscribes to it. You can be quite verbose here, up to 500characters or

    # so. You can continue to a new line by adding a backslash to theend of the# line. Default is to have no description.#jspwiki.rss.channelDescription = Oh poor me, my owner has not set \

    a channel description at all. \Pity me.

    ## The language of your Wiki. This is a standard, two-letter language# code, or in case of some languages, two letters for the country,# a dash, and two letters for the dialect.#jspwiki.rss.channelLanguage = en-us

    ############################################################################# JDBC Configuration. Tells JSPWiki which tables and columns to map# to for the JDBCUserDatabase and JDBCGroupDatabase. For more info,see the# JavaDoc for classes com.ecyrd.jspwiki.auth.user.JDBCUserDatabaseand# com.ecyrd.jspwiki.auth.authorize.JDBCGroupDatabase.#jspwiki.userdatabase.datasource=jdbc/UserDatabasejspwiki.userdatabase.table=usersjspwiki.userdatabase.uid=uidjspwiki.userdatabase.email=emailjspwiki.userdatabase.fullName=full_namejspwiki.userdatabase.loginName=login_namejspwiki.userdatabase.password=passwordjspwiki.userdatabase.wikiName=wiki_namejspwiki.userdatabase.created=created

  • 8/2/2019 jspwiki

    18/21

    jspwiki.userdatabase.modified=modifiedjspwiki.userdatabase.lockExpiry=lock_expiryjspwiki.userdatabase.attributes=attributesjspwiki.userdatabase.roleTable=rolesjspwiki.userdatabase.role=rolejspwiki.groupdatabase.datasource=jdbc/GroupDatabasejspwiki.groupdatabase.table=groupsjspwiki.groupdatabase.membertable=group_membersjspwiki.groupdatabase.created=createdjspwiki.groupdatabase.creator=creatorjspwiki.groupdatabase.name=namejspwiki.groupdatabase.member=memberjspwiki.groupdatabase.modified=modifiedjspwiki.groupdatabase.modifier=modifier

    ############################################################################

    # JavaMail configuration. If you wish to allow your users to recover# their passwords via email, you should configure these properties.# JavaMail can use either a container-managed JNDI resource factory# (recommended, and the default), or a stand-alone factory whoseproperties# are configured with mail.* properties in this file (below).#

    # A. Configure the address from which the email appears to come.# If you're going to use a mail session obtained via JNDI, thissetting# will only be used if it hasn't already been configured in theobtained# session itself. If you comment it out, JSPWiki will use itsinternal# default value.# If you're going to use a stand-alone mail session, you willsurely want# to configure it, otherwise the internal default value will beused.#mail.from = @mail.from@

    # B. JNDI Resource Factory Configuration. JSPWiki will try thisfirst.# You will need to configure your container to provide a JavaMail# resource factory. See your container documentation, or check our# fairly complete documentation (with examples for Tomcat) in# the JavaDocs for com.ecyrd.jspwiki.util.MailUtil.## JNDI resource name. The commented-out value is the default.#jspwiki.mail.jndiname = mail/Session

  • 8/2/2019 jspwiki

    19/21

    # C. Stand-alone Resource Factory. JSPWiki will use these values ifJNDI fails.## Your SMTP host (i.e. the one which sends email)mail.smtp.host = @mail.smtp.host@

    # If for some reason the standard smtp port (25) is blocked, you canchange it here#mail.smtp.port = @mail.smtp.port@

    # If you are using a webserver that is publically accessible itusually# doesn't allow you to send mail anonymously# (because then this mailserver would become an open relay).# Therefore you can indicate your account information here...##mail.smtp.account = @mail.smtp.account@#mail.smtp.password = @mail.smtp.password@

    # The properties below control connection timeouts and TLS(encryption)# if the mailserver supports it. The commented-out values are thedefaults.#mail.smtp.timeout = 5000#mail.smtp.connectiontimeout = 5000#mail.smtp.starttls.enable = true

    ############################################################################# Configure logs. See log4j documentation for more information# on how you can configure the logs.## Log4j is available at http://jakarta.apache.org/log4j## WARNING WARNING WILL ROBINSON: If you turn on DEBUG logging, beaware# that some security-sensitive information will be logged (such assession IDs).# Please be careful.## Send mail to root on all problems containing warnings.##log4j.appender.mail = org.apache.log4j.net.SMTPAppender#log4j.appender.mail.Threshold = WARN#log4j.appender.mail.To = root@localhost#log4j.appender.mail.From = JSPWiki@localhost#log4j.appender.mail.Subject = Problem with JSPWiki!#log4j.appender.mail.SMTPHost = mail

    #log4j.appender.mail.layout = org.apache.log4j.PatternLayout#log4j.appender.mail.layout.ConversionPattern =%d [%t] %p %c %x - %m%n

  • 8/2/2019 jspwiki

    20/21

    ## Log everything into a file, roll it over every 10 MB, keep# only 14 latest ones.#log4j.appender.FileLog = org.apache.log4j.RollingFileAppenderlog4j.appender.FileLog.MaxFileSize = 10MBlog4j.appender.FileLog.MaxBackupIndex = 14log4j.appender.FileLog.File = /tmp/jspwiki.loglog4j.appender.FileLog.layout = org.apache.log4j.PatternLayoutlog4j.appender.FileLog.layout.ConversionPattern=%d [%t] %p %c %x -%m%n

    ## If you want to use some other logging system (such as JBoss, whichuses# log4j already, comment this line out. If you just don't want anylogs

    # at all, you can set it to be empty. However, I suggest that you do# at least to a level of WARN.#log4j.rootCategory=INFO,FileLog

    # Enable if you're using mailing, above.#log4j.rootCategory=INFO,FileLog,mail

    ## Uncomment these lines if you want to see detailed security eventlogging.# The logging levels are as follows:# ERROR: login errors (other than failed/expired logins)# WARN: access denied, failed login (account expired,password/credential expired)# INFO: login, logout# DEBUG: add/remove group, add/remove group member, cleargroups/group members, access allowed##log4j.logger.SecurityLog=INFO, SecurityAppender#log4j.appender.SecurityAppender =org.apache.log4j.RollingFileAppender#log4j.appender.SecurityAppender.MaxFileSize = 10MB#log4j.appender.SecurityAppender.MaxBackupIndex = 14#log4j.appender.SecurityAppender.File = @securitylog@#log4j.appender.SecurityAppender.layout =org.apache.log4j.PatternLayout#log4j.appender.SecurityAppender.layout.ConversionPattern=%d %p - %m%n

    ## Uncomment these lines if you wish to receive detailed spam# filter logging.##log4j.logger.SpamLog=INFO,SpamAppender

  • 8/2/2019 jspwiki

    21/21

    #log4j.appender.SpamAppender = org.apache.log4j.RollingFileAppender#log4j.appender.SpamAppender.MaxFileSize = 10MB#log4j.appender.SpamAppender.MaxBackupIndex = 14#log4j.appender.SpamAppender.File = @spamlog@#log4j.appender.SpamAppender.layout = org.apache.log4j.PatternLayout#log4j.appender.SpamAppender.layout.ConversionPattern=%d{ISO8601} %m%n

    ############################################################################# Workflow configuration## The following properties map specific workflow steps to theirassociated approvers# The name of the workflow or decision is the part of the key after"jspwiki.approver.".# This is a logical name JSPWiki uses to determine which Principal toconsult for approval.

    # The Principal is identified up by AuthorizationManager at runtime;it looks for a Principal# match as follows: GroupPrincipals; Roles; WikiPrincipals/otherprincipals. Thus, if a value# of "Admin" is supplied JSPWiki will first check the GroupManager tosee if group Admin exits;# then the container roles, if any; then, user Principals. If thevalue is blank or the# property is commented out, it means that the workflow does notrequire approval.## EXAMPLE:# Uncomment the next line to require the Admin group (or Admin user,if a group is not found)# to approve wiki pages after saving.#jspwiki.approver.workflow.saveWikiPage=Admin

    # Uncomment the next line to require the Admin group to approve newuser profiles#jspwiki.approver.workflow.createUserProfile=Admin

    ### End of configuration file.