1xsp(1) User Commands xsp(1)
2
6 XSP - Mono ASP.NET Web Server
7
9 mono xsp.exe [options]
10 or
12 mono mod-mono-server.exe [options]
14
16 XSP and mod-mono-server are both hosts for ASP.NET-based applications.
17 If run as `xsp', the process provides a minimalistic web server which
19 hosts the ASP.NET runtime and can be used to test and debug web appli‐
20 cations that use the System.Web facilities in Mono. This server is
21 most convenient for testing and running small sites, does not offer
22 everything a production web server offers.
23 `mod-mono-server' is an ASP.NET runtime host that can communicate with
25 another web server (at the time of this writing Apache 1.3 and Apache
26 2.0 were supported). This mechanism is better used for high-traffic
27 servers or production systems, since it can integrate with the main
28 HTTP server and leverage all of the optimizations and extensions of an
29 existing server, while providing the ASP.NET runtime. You can choose
30 the communication channel used between mod_mono and mod-mono-server. If
31 you provide a --filename option, a unix socket is used, otherwise you
32 can give --port to use a TCP socket.
33
35 --address addr
36 Sets the IP address to listen on. By default it's 0.0.0.0 for
37 xsp and 127.0.0.1 for mod-mono-server. AppSettings key name:
38 MonoServerAddress
39 --port PORT
41 Changes the default port where the XSP server will listen to
42 requests. By default XSP listens on port 8080 and mod-mono-
43 server has no default. AppSettings key name: MonoServerPort
44 --filename file (mod-mono-server only)
46 The unix socket file name to listen on. Default value:
47 /tmp/mod_mono_server AppSettings key name: UnixSocketFileName
48 --root PATH
50 The root directory for XSP. The default is the directory where
51 XSP is executed. The current directory will be changed to this
52 one before creating any application. AppSettings key name:
53 MonoServerRootDir
54 --appconfigfile FILENAME
56 Adds application definitions from the XML configuration file.
57 See sample configuration file that comes with the server (sam‐
58 ple.webapp) and WEBAPP FILE FORMAT below. AppSettings key name:
59 MonoApplicationsConfigFile
60 --appconfigdir DIR
62 Adds application definitions from all XML files found in the
63 specified directory DIR. Files must have '.webapp' extension.
64 AppSettings key name: MonoApplicationsConfigDir
65 --applications APPS
67 A comma separated list of virtual directory and real directory
68 for all the applications we want to manage with this server. The
69 virtual and real dirs. are separated by a colon. The default
70 value is '/:.'.
71 Some examples:
73 '/:.' The virtual / is mapped to the current directory.
75 '/blog:../myblog'
77 The virtual /blog is mapped to ../myblog
78 '/:.,/blog:../myblog'
80 Two applications like the above ones are handled.
81 myhost.someprovider.net:/blog:../myblog
83 The virtual /blog at myhost.someprovider.net is mapped to
84 ../myblog.
85 --master
87 This instance will be used to by mod_mono to create ASP.NET
89 applications on demand. If this option is provided, there is no
90 need to provide a list of applications to start. This applies
91 only to mod-mono-server.exe. --nonstop This applies only to
92 xsp.exe: by default xsp will stop processing requests when the
93 return key is pressed. Use this to avoid this behavior.
94 --https
96 Enables HTTPS support on the server, you must supply an X.509
97 certificate and a private key with either the --cert/--pkfile
98 options or with the --p12file (which combines both the certifi‐
99 cate and the private key into a single file).
100 To use you must first create an X.509 certificate for your server, for
102 example:
103 $ makecert -r -eku 1.3.6.1.5.5.7.3.1 -n "CN=server" -p12 server.p12 s3kr3t
104 Mono MakeCert - version 1.1.9.0
105 X.509 Certificate Builder
106 Copyright 2002, 2003 Motus Technologies. Copyright 2004-2005 Novell. BSD licensed.
107 Success
109 Then you must pass the following flags to xsp:
111 $ xsp --https --p12file server.p12 --pkpwd s3kr3t
112 This option is only valid for XSP. For mod_mono you should configure
114 Apache for SSL/TLS.
115 --https-client-accept
117 Like --https this enables HTTPS support on the server. However
118 this option also send an "invitation" to clients to provide
119 client-certificates to authenticate themselves. Client are free
120 to provide, or not, a client certificate. Web application can
121 detect if a client certificate is used and react accordingly.
122 Most web browser will not send a client certificate unless they
123 have been explicitly requested to do so.
124 This option is only valid for XSP. For mod_mono you should configure
126 Apache for SSL/TLS.
127 --https-client-require
129 Like --https this enables HTTPS support on the server. However
130 this option also requires clients to use client-certificates to
131 authenticate themselves. Client who do not provide client cer‐
132 tificates will receive an error. Note that client may send an
133 empty certificate structure so web application should check the
134 certificate content.
135 This option is only valid for XSP. For mod_mono you should configure
137 Apache for SSL/TLS.
138 --p12file FILENAME
140 Used to specify the PKCS#12 file to use. This file includes both
141 the X.509 certificate and the private key required to encrypt
142 the HTTP traffic.
143 This option is only valid for XSP. For mod_mono you should configure
145 Apache for SSL/TLS.
146 --cert FILENAME
148 Used to specify the server X.509 certificate file. This is nor‐
149 mally used with the --pkfile.
150 This option is only valid for XSP. For mod_mono you should configure
152 Apache for SSL/TLS.
153 --pkfile FILENAME
155 Used to specify the path to the private keyfile. The PVK format
156 isn't very secure and you should use the PKCS#12 format
157 (--p12file option) to store new private keys.
158 This option is only valid for XSP. For mod_mono you should configure
160 Apache for SSL/TLS.
161 --pkpwd PASSWORD
163 If your private key is password protected, PASSWORD is the pass‐
164 word used to decote the private key. This option works for both
165 PVK and PKCS#12 formats.
166 This option is only valid for XSP. For mod_mono you should configure
168 Apache for SSL/TLS.
169 --protocol PROTOCOL
171 Specifies which protocols are available for encrypting the com‐
172 munications. The possible values are Default, Tls and Ssl3.
173 Ssl2 isn't supported. The default value is "Default" which
174 auto-detect the client protocol and adjust the server protocol
175 accordingly.
176 This option is only valid for XSP. For mod_mono you should configure
178 Apache for SSL/TLS.
179 --terminate (mod-mono-server only)
181 Gracefully terminates a running mod-mono-server instance. All
182 other options but --filename or --address and --port" are
183 ignored if this option is provided.
184 --version
186 Displays version information and exits.
187 --help Shows the list of options and exits.
189 --verbose
191 Prints extra messages. Useful for debugging.
192
194 You can choose which files are considered as index using xsp.exe.config
195 configuration file like this:
196 <appSettings>
198 <add key="MonoServerDefaultIndexFiles"
199 value="index.aspx" />
200 </appSettings>
201 By default, it has index.aspx, Default.aspx, default.aspx, index.html
203 and index.htm. The order matters.
204
207 The format of the .webapp files used for --appconfigfile and --appcon‐
208 figdir is:
209 <apps>
211 <web-application>
212 <name>{appname}</name>
213 <vhost>{virtual host for application}</vhost>
214 <vport>{port for the application}</vport>
215 <vpath>{virtual directory in apache}</vpath>
216 <path>{physical path to aspx files}</path>
217 <!-- <enabled> is true by default -->
218 <enabled>{true|false}</enabled>
219 </web-application>
220 </apps>
221 You can include any number of <web-application> nodes, one per ASP.NET
223 application to run.
224 There's a sample.webapp file in the XSP samples directory.
226
229 The Mono XSP server was written by Gonzalo Paniagua Javier (gon‐
230 zalo@ximian.com).
231
233 mono(1),dbsessmgr(1),asp-state(1),mod_mono(8),makecert(1)
234 For more information on creating certificates, see:
236 http://pages.infinit.net/ctech/20050701-1048.html
237 System.Web, System.Web.Hosting namespaces.
239 http://www.asp.net is Microsoft's official site for ASP.NET
241
243 The Mono project (http://www.go-mono.com) is a collaborative effort led
244 by Novell (http://www.novell.com) to implement an open source version
245 of the .NET Framework.
246xsp 1.2.1 21 Nov 2004 xsp(1)