Ubuntu Manpage: XSP - Mono ASP.NET Web Server (xsp and xsp2)

Provided by: mono-apache-server4_3.0.11-1_all

NAME

       XSP - Mono ASP.NET Web Server (xsp and xsp2)

SYNOPSIS

       xsp [options]

       or

       mod-mono-server4 [options]

       or

       fastcgi-mono-server4 [options]

DESCRIPTION

       XSP, mod-mono-server4 and fastcgi-mono-server4 are hosts for ASP.NET-based applications.

       If  run  as  `xsp', the process provides a minimalistic web server which hosts the ASP.NET
       runtime and can be used to test  and  debug  web  applications  that  use  the  System.Web
       facilities  in  Mono.  This server is most convenient for testing and running small sites,
       does not offer everything a production web server offers.

       `mod-mono-server4' and 'fastcgi-mono-server4' are both ASP.NET  runtimes  hosts  that  can
       communicate  with  another  web  server  (at the time of this writing, Apache 1.3-2.2 were
       supported through mod_mono and several other web servers through FastCGI).  This mechanism
       is better used for high-traffic servers or production systems, since it can integrate with
       the main HTTP server and leverage all of the optimizations and extensions of  an  existing
       server, while providing the ASP.NET runtime. You can choose the communication channel used
       between mod_mono and mod-mono-server4. If you provide a --filename option, a  unix  socket
       is used, otherwise you can give --port to use a TCP socket.

OPTIONS

--address addr
Sets the IP address to listen on. By default it's 0.0.0.0 for xsp and 127.0.0.1 for
mod-mono-server4. AppSettings key name: MonoServerAddress

--port PORT
Changes the default port where the XSP server will listen to requests. By default
XSP listens on port 8080 and mod-mono-server4 has no default. AppSettings key
name: MonoServerPort

--backlog N
The backlog of connections to set on the listener socket. By default the value is
set to 500.

--minThreads N
The minimum number of threads the threadpool allocates. Increase this value to
better handle the sudden arrival of connections. The default value is determined
by the mono runtime.

--filename file (mod-mono-server4 and fastcgi-mono-server4)
The unix socket file name to listen on. Default value: /tmp/mod_mono_server
(fastcgi-mono-server4: /tmp/fastcgi-mono-server4) AppSettings key name:
UnixSocketFileName (fastcgi-mono-server4: MonoUnixSocket)

--root PATH
The root directory for XSP. The default is the directory where XSP is executed.
The current directory will be changed to this one before creating any application.
AppSettings key name: MonoServerRootDir

--appconfigfile FILENAME
Adds application definitions from the XML configuration file. See sample
configuration file that comes with the server (sample.webapp) and WEBAPP FILE
FORMAT below. AppSettings key name: MonoApplicationsConfigFile

--appconfigdir DIR
Adds application definitions from all XML files found in the specified directory
DIR. Files must have '.webapp' extension. AppSettings key name:
MonoApplicationsConfigDir

--applications APPS
A comma separated list of virtual directory and real directory for all the
applications we want to manage with this server. The virtual and real dirs. are
separated by a colon. The default value is '/:.'.

Some examples:

'/:.' The virtual / is mapped to the current directory.

'/blog:../myblog'
The virtual /blog is mapped to ../myblog

'/:.,/blog:../myblog'
Two applications like the above ones are handled.

myhost.someprovider.net:/blog:../myblog
The virtual /blog at myhost.someprovider.net is mapped to ../myblog.

--master

This instance will be used to by mod_mono to create ASP.NET
applications on demand. If this option is provided, there is no need to provide a
list of applications to start. This applies only to mod-mono-server4.exe.
--nonstop By default xsp/mod-mono-server4 will stop processing requests when the
return key is pressed. Use this to avoid this behavior.

--no-hidden
Do not protect hidden files/directories from being accessed by clients. Hidden
files/directories are those with Hidden attribute on Windows and whose name starts
with a dot on Unix. Any file/directory below a hidden directory is inacessible.
This option turns the default behavior of protecting such locations off. If your
application does not contain any hidden files/directories, you might want to use
this option as the checking process has a per-request cost. AppSettings key name:
MonoServerCheckHiddenFiles (a boolean accepting 'true' or 'false')

--https
Enables HTTPS support on the server, you must supply an X.509 certificate and a
private key with either the --cert/--pkfile options or with the --p12file (which
combines both the certificate and the private key into a single file).

To use you must first create an X.509 certificate for your server, for
example:
$ makecert -r -eku 1.3.6.1.5.5.7.3.1 -n "CN=server" -p12 server.p12 s3kr3t
Mono MakeCert - version 1.1.9.0
X.509 Certificate Builder
Copyright 2002, 2003 Motus Technologies. Copyright 2004-2005 Novell. BSD licensed.

Success

Then you must pass the following flags to xsp:
$ xsp --https --p12file server.p12 --pkpwd s3kr3t