.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mojolicious::Static 3pm"
.TH Mojolicious::Static 3pm 2024-05-15 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mojolicious::Static \- Serve static files
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mojolicious::Static;
\&
\&  my $static = Mojolicious::Static\->new;
\&  push @{$static\->classes}, \*(AqMyApp::Controller::Foo\*(Aq;
\&  push @{$static\->paths}, \*(Aq/home/sri/public\*(Aq;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mojolicious::Static is a static file server with \f(CW\*(C`Range\*(C'\fR, \f(CW\*(C`If\-Modified\-Since\*(C'\fR and \f(CW\*(C`If\-None\-Match\*(C'\fR support, based
on RFC 7232 <https://tools.ietf.org/html/rfc7232> and RFC 7233 <https://tools.ietf.org/html/rfc7233>.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
Mojolicious::Static implements the following attributes.
.SS asset_dir
.IX Subsection "asset_dir"
.Vb 2
\&  my $dir = $static\->asset_dir;
\&  $static = $static\->asset_dir(\*(Aqassets\*(Aq);
.Ve
.PP
Subdirectory used for all static assets, defaults to \f(CW\*(C`assets\*(C'\fR.
.SS classes
.IX Subsection "classes"
.Vb 2
\&  my $classes = $static\->classes;
\&  $static     = $static\->classes([\*(Aqmain\*(Aq]);
.Ve
.PP
Classes to use for finding files in \f(CW\*(C`DATA\*(C'\fR sections with Mojo::Loader, first one has the highest precedence,
defaults to \f(CW\*(C`main\*(C'\fR. Only files with exactly one extension will be used, like \f(CW\*(C`index.html\*(C'\fR. Note that for files to be
detected, these classes need to have already been loaded and added before "warmup" is called, which usually happens
automatically during application startup.
.PP
.Vb 2
\&  # Add another class with static files in DATA section
\&  push @{$static\->classes}, \*(AqMojolicious::Plugin::Fun\*(Aq;
\&
\&  # Add another class with static files in DATA section and higher precedence
\&  unshift @{$static\->classes}, \*(AqMojolicious::Plugin::MoreFun\*(Aq;
.Ve
.SS extra
.IX Subsection "extra"
.Vb 2
\&  my $extra = $static\->extra;
\&  $static   = $static\->extra({\*(Aqfoo/bar.txt\*(Aq => \*(Aq/home/sri/myapp/bar.txt\*(Aq});
.Ve
.PP
Paths for extra files to be served from locations other than "paths", such as the images used by the built-in
exception and not found pages. Note that extra files are only served if no better alternative could be found in
"paths" and "classes".
.PP
.Vb 2
\&  # Remove built\-in favicon
\&  delete $static\->extra\->{\*(Aqfavicon.ico\*(Aq};
.Ve
.SS paths
.IX Subsection "paths"
.Vb 2
\&  my $paths = $static\->paths;
\&  $static   = $static\->paths([\*(Aq/home/sri/public\*(Aq]);
.Ve
.PP
Directories to serve static files from, first one has the highest precedence.
.PP
.Vb 2
\&  # Add another "public" directory
\&  push @{$static\->paths}, \*(Aq/home/sri/public\*(Aq;
\&
\&  # Add another "public" directory with higher precedence
\&  unshift @{$static\->paths}, \*(Aq/home/sri/themes/blue/public\*(Aq;
.Ve
.SS prefix
.IX Subsection "prefix"
.Vb 2
\&  my $prefix = $static\->prefix;
\&  $static    = $static\->prefix(\*(Aq/static\*(Aq);
.Ve
.PP
Prefix to use for all static files, defaults to \f(CW\*(C`undef\*(C'\fR. This can be very useful for production deployments where the
reverse proxy server should take over serving static files.
.SH METHODS
.IX Header "METHODS"
Mojolicious::Static inherits all methods from Mojo::Base and implements the following new ones.
.SS asset_path
.IX Subsection "asset_path"
.Vb 1
\&  my $path = $static\->asset_path(\*(Aq/app.js\*(Aq);
.Ve
.PP
Get static asset path.
.SS dispatch
.IX Subsection "dispatch"
.Vb 1
\&  my $bool = $static\->dispatch(Mojolicious::Controller\->new);
.Ve
.PP
Serve static file for Mojolicious::Controller object.
.SS file
.IX Subsection "file"
.Vb 2
\&  my $asset = $static\->file(\*(Aqimages/logo.png\*(Aq);
\&  my $asset = $static\->file(\*(Aq../lib/MyApp.pm\*(Aq);
.Ve
.PP
Build Mojo::Asset::File or Mojo::Asset::Memory object for a file, relative to "paths" or from "classes",
or return \f(CW\*(C`undef\*(C'\fR if it doesn't exist. Note that this method uses a relative path, but does not protect from
traversing to parent directories.
.PP
.Vb 1
\&  my $content = $static\->file(\*(Aqfoo/bar.html\*(Aq)\->slurp;
.Ve
.SS file_path
.IX Subsection "file_path"
.Vb 1
\&  my $path = $static\->file_path(\*(Aq/index.html\*(Aq);
.Ve
.PP
Get static file path with "prefix" if it has been configured.
.SS is_fresh
.IX Subsection "is_fresh"
.Vb 3
\&  my $bool = $static\->is_fresh(Mojolicious::Controller\->new, {etag => \*(Aqabc\*(Aq});
\&  my $bool = $static\->is_fresh(
\&    Mojolicious::Controller\->new, {etag => \*(AqW/"def"\*(Aq});
.Ve
.PP
Check freshness of request by comparing the \f(CW\*(C`If\-None\-Match\*(C'\fR and \f(CW\*(C`If\-Modified\-Since\*(C'\fR request headers to the \f(CW\*(C`ETag\*(C'\fR
and \f(CW\*(C`Last\-Modified\*(C'\fR response headers.
.PP
These options are currently available:
.IP etag 2
.IX Item "etag"
.Vb 2
\&  etag => \*(Aqabc\*(Aq
\&  etag => \*(AqW/"abc"\*(Aq
.Ve
.Sp
Add \f(CW\*(C`ETag\*(C'\fR header before comparing.
.IP last_modified 2
.IX Item "last_modified"
.Vb 1
\&  last_modified => $epoch
.Ve
.Sp
Add \f(CW\*(C`Last\-Modified\*(C'\fR header before comparing.
.SS serve
.IX Subsection "serve"
.Vb 2
\&  my $bool = $static\->serve(Mojolicious::Controller\->new, \*(Aqimages/logo.png\*(Aq);
\&  my $bool = $static\->serve(Mojolicious::Controller\->new, \*(Aq../lib/MyApp.pm\*(Aq);
.Ve
.PP
Serve a specific file, relative to "paths" or from "classes". Note that this method uses a relative path, but
does not protect from traversing to parent directories.
.SS serve_asset
.IX Subsection "serve_asset"
.Vb 1
\&  $static\->serve_asset(Mojolicious::Controller\->new, Mojo::Asset::File\->new);
.Ve
.PP
Serve a Mojo::Asset::File or Mojo::Asset::Memory object with \f(CW\*(C`Range\*(C'\fR, \f(CW\*(C`If\-Modified\-Since\*(C'\fR and \f(CW\*(C`If\-None\-Match\*(C'\fR
support.
.SS warmup
.IX Subsection "warmup"
.Vb 1
\&  $static\->warmup();
.Ve
.PP
Prepare static files from "classes" and static assets for future use.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.