Apache::GitFileServer

mod_perl2 module to serve files from git repositories.

SYNOPSIS

This module allows to serve file directly from git repositories to browsers. Its main purpose is to easily publish files using git.

Features

Reply only to GET and HEAD requests; deny other methods with a 405 (Bad Method) response.
Set Content-Length.
Set Content-Type based on file extension, using File::MimeInfo.
Allow caching by setting ETag in response and properly handling If-None-Match header in requests.
Do not allow exploring: do not list repositories, references nor tree content.

INSTALLATION

This module obviously needs Apache2, mod_perl2 and git binaries. It also uses System::Sub and File::MimeInfo.

On Debian Wheezy, you should be able to install them with these commands:

aptitude install libapache2-mod-perl2 git libfile-mimeinfo-perl cpan
cpan install System::Sub

Install this module in one of mod_perl2 @INC directories.

CONFIGURATION

Here is a sample configuration with all the configuration parameters.

# Load the module
PerlLoadModule Apache::GitFileServer

# Serve files from repositories
<Location /pages>
        SetHandler modperl
        PerlResponseHandler Apache::GitFileServer
        
        # Where does the bare repositories live ?
        GitRepositoryRoot      /var/lib/git
        
        # Suffixes repository name with "-pages", e.g. /pages/myrepo => /var/lib/git/myrepo-pages
        # Default: -pages
        # GitRepositoryDirSuffix -pages
        
        # Redirect /pages/myrepo to /pages/myrepo/master
        # Default: master
        # GitDefaultBranch       master
        
        # Redirect /pages/myrepo/anyref to /pages/myrepo/anyref/index.html
        # GitDefaultIndex       index.html
        # GitDefaultIndex        index.html
</Location>

CAVEATS

Even though this module should not consume much ressources, it has not been optimized for performance. It executes "git cat-file" at least once per request and executes a second time to actually serve the file content.

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

adirelle / apache-gitfileserver Goto Github PK