NAME

Modwheel::Manual::Config - Modwheel configuration.

DESCRIPTION

This is a reference on the directives available in the Modwheel configuration file.

GLOBAL CONFIGURATION

debug

Turn debug messages on or off.

Example:

debug: 1

defaultsite

The site to use if no site is specified.

Example:

defaultsite: Simple

directoryindex

This is the default file to use for directories when no filename is specified.

Example:

directoryindex: index.html

templatedriver

Default representation engine.

Example (for Template Toolkit):

templatedriver: TT 

locale

Global locale setting. This setting is used for all sites with no locale setting. See: locale.1

Example: no_NO

SITES

directoryindex

This is the default file to use for directories when no filename is specified.

Example:

directoryindex: index.html

locale

Locale setting for this site. See: locale.1

Example:

locale: en_EN

repository

The directory for the repository system to upload files in.

Example:

repository: /opt/modwheel/Repository 

If used with Apache, this directory has to be writable by the user Apache is running as.

repositoryurl

This is the URL location users can access the repository directory from using the web-server.

Example:

In httpd.conf:

Alias /rep  /opt/modwheel/Repository
<Directory  /opt/modwheel/Repository/*/*>
    Order Deny, Allow
    Allow from all
</Directory>

in modwheelconfig.yml:

repositoryurl: /rep 

NeverDetach

Never detach objects from the tree. This is useful for admin sites, where you don't want objects with the detach flag set to detach from the tree.

Example:

NeverDetach: Yes

templatedir

The location of the template for this site.

Example:

templatedir: /opt/modwheel/Template/Simple

templatedriver

The representation engine to use. Only TT supported at this time (Template Toolkit).

Example:

templatedriver: TT

database

Database configuration.

type

Type of database server to use. Only MySQL supported at this time.

Example:

type: MySQL

name

Name of the database to use.

Example:

name: modwheel

host

Hostname the database server is running on. By IP-address or DNS name.

Example:

host: localhost

Or:

host: 127.0.0.1

username

Username to log into the database with.

Example:

username: modwheel_user

password

Password for the username above.

password: definityinfinity

port

TCP Port on the hostname the server is running on.

Example:

port: 3306

TT

Template Toolkit configuration.

plugins

A list of plugins to preload into Template Toolkit. (like [% USE ... %])

Example:

plugins:
    HTML: Template::Plugin::HTML
    Date: Template::Plugin::Date
    URL:  Template::Plugin::URL

OBJECT DEFAULTS

inherit

If set to true new objects will inherit active flag, owner, sort priority, and custom template from their parent object.

Example:

inherit: 1

active

If set to true new objects are active by default.

Example: active: 1

owner

New objects are owned by this user-id by default. You can list users and their id with the command line utility mwuser.

/opt/modwheel/bin/mwuser -list

Example:

owner: 100

groupo

New objects are owned by this group-id by default. No

parent

Default parent for new objects. (1 is probably a good choice).

SHORTCUTS

Write something about shortcuts here.

MORE INFORMATION

• Modwheel::Manual::Installation

  Help on installing Modwheel.

• Modwheel::Manual::Intro

  Introduction on how to use Modwheel with the Template Toolkit.

• Apache2::Modwheel

  Information on using Modwheel with Apache2. You have to install the Apache2::Modwheel module from CPAN.

• Modwheel::Manual::Plugins

  Tutorial on how to extend Modwheel with plugins.

• Modwheel::Manual::DB

  Information on how to use the Modwheel $db object to operate on databases.

AUTHOR

Ask Solem <ask@0x61736b.net> http://www.0x61736b.net

COPYRIGHT, LICENSE

Copyright (C) 2007 by Ask Solem ask@0x61736b.net.

All rights reserved.

This documentation is free; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.