view release on metacpan or  search on metacpan

lib/Any/Daemon/HTTP/VirtualHost.pod  view on Meta::CPAN

=encoding utf8

=head1 NAME

Any::Daemon::HTTP::VirtualHost - webserver virtual hosts

=head1 SYNOPSIS

 my $vhost  = Any::Daemon::HTTP::VirtualHost->new
  ( directories => ...
  , rewrite     => ...
  , handlers    => ...
  );

 my $daemon = Any::Daemon::HTTP->new
   ( @other_options
   , vhosts  => $vhost  # or \@vhosts
   );

 # or
 my $daemon = Any::Daemon::HTTP->new(@other_opts);
 $daemon->addVirtualHost($vhost);
 $daemon->addVirtualHost(@vhost2_opts);

 # create object which extends Any::Daemon::HTTP::VirtualHost
 my $myvhost = MyVHost->new(...);
 $daemon->addVirtualHost($myvhost);

=head1 DESCRIPTION

These virtual host (vhost) configuration are used by L<Any::Daemon::HTTP|Any::Daemon::HTTP>,
to implement (server) name based data separation.  Its features resemble
those of Apache virtual hosts.

Each vhost usually has two L<Any::Daemon::HTTP::Directory|Any::Daemon::HTTP::Directory> slaves:
one which describes the permissions for user directories (url paths in the
form C< /~user/ >), the other for data outside the user space.

=head1 METHODS

=head2 Constructors

You may avoid the creation of extension classes for each virtual host,
by using these options.

=over 4

=item Any::Daemon::HTTP::VirtualHost-E<gt>B<new>(%options|\%options)

 -Option     --Default
  aliases      'AUTO'
  directories  <see text>
  directory    undef
  documents    <undef>
  handler      undef
  handlers     {}
  name         <required>
  proxies      undef
  proxy        undef
  redirect     <undef>
  rewrite      <undef>