The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Apache2-Modwheel-0.2.3
/ Apache2::Modwheel

NAME

Apache2::Modwheel - Use Modwheel with mod_perl2

VERSION

This document describes Apache2::Modwheel version 0.0.2

SYNOPSIS

<VirtualHost *:80>
        ServerName admin.localhost
    ErrorLog logs/error_log
    <Location />
        SetHandler perl-script                                                                                                             
        PerlAuthenHandler   Apache2::Modwheel::Authen
        PerlResponseHandler Apache2::Modwheel
        PerlSetVar ModwheelPrefix       /opt/devel/Modwheel
        PerlSetVar ModwheelConfigFile   config/modwheelconfig.yml
        PerlSetVar ModwheelSite         Admin
        PerlSetVar ModwheelFileUploads  Yes
        PerlSetVar ModwheelCachedDB     Yes
        PerlSetVar Locale               en_EN
        PerlSetVar DontHandle           "rep javascript css images scriptaculous"
                                                                                                                                      
        AuthType Basic                                                                                                                    
        AuthName "void"                                                                                                                   
        Require valid-user                                                                                                                
    </Location>                                                                                                                           
    Alias /rep /opt/devel/Modwheel/Repository                                                                                             
    Alias /css /opt/devel/Modwheel/Templates/SimpleAdmin/css                                                                              
    Alias /javascript /opt/devel/Modwheel/Templates/SimpleAdmin/javascript                                                                
    Alias /scriptaculous /opt/devel/Modwheel/Templates/Scriptaculous                                                                      
    <Directory /opt/devel/Modwheel/Repository/*/*>                                                                                        
        Order Deny,Allow                                                                                                                  
        Allow from all                                                                                                                    
    </Directory>                                                                                                                          
    <Directory /opt/devel/Modwheel/Templates/*/*>                                                                                         
        Order Deny,Allow                                                                                                                  
        Allow from all                                                                                                                    
    </Directory>                                                                                                                          
</VirtualHost>

DESCRIPTION

HANDLERS

PerlResponseHandler Apache2::Modwheel

This is the main Modwheel handler. It requires that you have the ModwheelPrefix and ModwheelConfigFile options set.

PerlAuthenHandler Apache2::Modwheel::Authen

This module is for authentication via the modwheel user system.

SUBROUTINES/METHODS

CONFIGURATION AND ENVIRONMENT

APACHE CONFIGURATION DIRECTIVES

PerlSetVar ModwheelPrefix

This is the directory you installed Modwheel to.

Example:

PerlSetVar ModwheelPrefix "/opt/Modwheel"
PerlSetVar ModwheelConfigFile

This is the Modwheel configuration file to use. If the filename is relative Modwheel will search for it in the ModwheelPrefix directory.

Example:

PerlSetVar ModwheelConfigFile "config/Modwheelconfig.yml"
PerlSetVar ModwheelSite

The site to use. Sites are configured in the configuration file.

Example:

PerlSetVar ModwheelSite "SimpleAdmin"
PerlSetVar ModwheelFileUploads

Users will be able to upload files to the site if this is set to Yes. This is used for the Repositories.

Example:

PerlSetVar ModwheelFileUploads Yes
PerlSetVar ModwheelWebPathToId

If this is set to yes, a user can enter i.e http://foo.bar/Music/Aphex Twin in his browser and Modwheel will find the node in the object tree with this name.

Example:

PerlSetVar ModwheelWebPathToId Yes
PerlSetVar Locale

What language the site is in. For a list of the values that are possible with this directive you can enter this command: (if you are running a form of Unix):

locale -a

Example:

PerlSetVar Locale en_EN
PerlSetVar DontHandle

URL's that Modwheel should'nt handle for this site. This is meant for static content that does not need any content. i.e /images, /javascript and so on.

Example:

PerlSetVar DontHandle "rep javascript css images scriptaculous"
PerlSetVar ModwheelDBCached

Turn on database handle cache.

Example:

PerlSetVar ModwheelCachedDB Yes
PerlSetVar ModwheelCachedDB No
PerlSetVar NoDatabaseConnect

Modwheel will not connect to the database if this is set to 'Yes'.

Example:

PerlSetVar NoDatabaseConnect Yes
PerlSetVar ContentType

Set the content type for this site.

Example:

PerlSetVar ContentType "text/html"
PerlSetVar ModwheelFollowTemplates

If a object has a user-specified template defined and ModwheelFollowTemplates is set to 'Yes', it will choose this template instead of the default.

Example:

PerlSetVar ModwheelFollowTemplates Yes

DIAGNOSTICS

Try running the Apache server in single process mode, with httpd -X.

INCOMPATIBILITIES

None known.

EXPORT

None.

DEPENDENCIES

  • Modwheel v0.0.2

  • libapreq2 2.0

  • mod_perl2 2.0

  • Readonly

  • Scalar::Util

  • version

BUGS AND LIMITATIONS

No bugs reported.

SEE ALSO

AUTHOR

Ask Solem, ask@0x61736b.net.

LICENSE AND COPYRIGHT

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

All rights reserved.

This library is free software; 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.