- NAME
- SYNOPSIS
- DESCRIPTION
- COMMANDS
  - add all
  - delete all
  - add map
  - delete map
  - add vdir
  - delete vdir
  - list sites

# NAME

ap-iis-config - Configure IIS for ActivePerl

# SYNOPSIS

      ap-iis-config add all
      ap-iis-config delete all
      ap-iis-config list sites

      ap-iis-config add map --ext .cgi --type isapi
      ap-iis-config delete map --ext .plex

      ap-iis-config add vdir --site 1 --name Sample --path C:\www\samples
      ap-iis-config delete vdir --site 2 --name "My Site"

# DESCRIPTION

ap-iis-config is a utility to setup IIS for use with ActivePerl. It creates and deletes script mappings and virtual directories.

Currently ap-iis-config only supports numeric site ids. Use the ap-iis-config list sites command to map site ids to descriptive names. The site id 0 can be used to add or remove script mappings from the webserver root itself (inherited by all websites).

# COMMANDS

All commands support the --verbose option in addition to the command-specific options listed below.

## add all

The ap-iis-config add all command will add all applicable script mappings to both the root configuration and to the default website.

      ap-iis-config add all [--site ID]* [--cgi] [--isapi] [--perlex]

The --cgi option will add a `*.pl` mapping for perl.exe. The --isapi option will add a `*.plx` mapping for perlis.dll, the Perl for ISAPI plugin. The --perlex option will add both `*.plex` and `*.aspl` mappings for the PerlEx plugin.

When no options are specified then all available script mappings will be configured.

If no --site is specified, then the script mappings will be added to both the root configuration and to the default web site (sites 0 and 1). In that case ap-iis-config will also add a virtual PerlEx directory to the default web site that will point to the PerlEx samples directory (if PerlEx has been installed).

On Windows Vista and later ap-iis-config add all will attempt to install IIS7 including the optional CGI and ISAPI modules, as required. For older versions of Windows IIS must be installed manually before running this command. If IIS is not yet installed, then ap-iis-config does nothing.

## delete all

ap-iis-config delete all will remove all Perl script mappings and virtual directories.

      ap-iis-config delete all [--site ID]*

If the --site option is not specified then mappings and directories are removed from the root configuration and default web site only (sites 0 and 1). The --site option also supports the * wildcard argument, which will remove the settings from all sites.

See the description of the delete map and delete vdir for the definition of Perl script mapping and Perl virtual directory.

## add map

ap-iis-config add map adds a script mapping to one or more web sites.

      ap-iis-config add map --ext EXT [--site ID] [--type cgi|isapi|perlex]

By default the mapping is added to the the root configuration (site 0).

The default --type depends on the script extension EXT: for `--ext .plx` the default is `--type isapi`, for `--ext .plex` and `--ext .aspl` the default is `--type perlex`. For all other extensions the default is `--type cgi`.

## delete map

ap-iis-config delete map removes one or more script mappings from a website.

      ap-iis-config delete map [--site ID] [--ext EXT]

The default for --ext is `.pl` and for --site is `0`.

The --ext option also supports the * wildcard argument, which will remove all Perl mappings from the site. A Perl mapping is defined as one that either maps to a script processor in the current Perl bin directory, or a script processor that isn't installed anymore and that matches the regex `/\bperl/i`.

## add vdir

ap-iis-config add vdir will add a virtual directory to a web site.

      ap-iis-config add vdir --path PATH [--side ID] [--name NAME]

The default site ID is 1. It is not possible to add a virtual directory to the root configuration (site 0).

The physical PATH must exist.

If the --name option is not specified then the lowest level part of PATH will be used for the virtual NAME. For example

      ap-iis-config add vdir --path C:\Perl\eg

is the same as

      ap-iis-config add vdir --site 1 --name eg --path C:\Perl\eg

## delete vdir

ap-iis-config delete vdir removes one or more virtual directories from a web site.

      ap-iis-config delete vdir [--site ID] [--name NAME]

The default site ID is 1.

The --name option also supports the `*` wildcard argument, which will remove all virtual Perl directories from the specified site. A Perl directory is defined as one whose physical path points anywhere inside the Perl install directory, for example C:\Perl\eg.

## list sites

ap-iis-config list sites displays a list of all site ids and their descriptions.

      ap-iis-config list sites

There are no further options for this command.