|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Announcements
Chapters
Services
Feature Zones
|
IntroductionThis article is the second article in the series of introductory articles that I am writing about Mono, the "open source development platform based on the .NET framework". In this article we'll take a look at how to get going with ASP.NET on the Mono platform. Although ASP.NET is not part of the ECMA and ISO standards mentioned in the first article[^], it is still one of the major selling points of the .NET platform and provides an extremely flexible and powerful platform for developing web applications and Web Services upon. Although you can develop ASP.NET applications for Mono on a number of different operating systems this article will focus mainly on Linux, although, in saying that, I do look briefly at getting XSP running on Windows. The reason I will concentrate on ASP.NET on Linux is because those people interested in ASP.NET on Windows have an extremely powerful option at their fingertips in the form IIS and I would whole heartedly recommend using it for ASP.NET on Windows. Where does ASP.NET stand with Mono??The latest stable version of Mono, version 1.0.5, has a fully functional implementation of ASP.NET. This includes full support for ASP.NET Web Forms and Web Services. This essentially means that more or less any ASP.NET application that you have developed using with the .NET Framework will work with Mono. Obviously there might be changes needed, such as data access changes, removal of any reliance on .NET Framework BCL types that are not implemented in Mono yet, and also the removal of any code that makes use of platform invoke and so on. At this stage the ASP.NET support in Mono can be considered as excellent and a lot of publicly available web applications already make use of Mono's ASP.NET support. According to the Mono site the Mono Web Services stack is being used in the source control application Vault[^] by SourceGear and aspects of Mono's ASP.NET implementation are also used in the Virtuoso[^] product from OpenLink. What are XSP and mod_mono?There isn't much point in developing web applications and Web Services if you have no way of serving them, is there? Traditionally you would use IIS to host ASP.NET applications on Windows, although there are some other free ASP.NET web servers available such as Cassini[^]. However, when using ASP.NET with Mono you have two main options as regards which web server to host your ASP.NET applications in:
In this article we look at using both XSP (on Windows and Linux) and Apache to host your ASP.NET web applications and Web Services. XSPXSP is a "light-weight web server" capable of hosting and serving ASP.NET applications. It is written using C#, making extensive use of the classes in the ApacheApache is probably the de facto standard web server used on Linux. Apache makes extensive use of modules to enable it to host and serve web applications developed in a multitude of different web programming languages and scripts. Those of you familiar with IIS but not so familiar with Apache can think of these modules as the equivalent of ISAPI extensions. So, by this stage I assume you can guess how Apache can host and serve ASP.NET application? Yep, using an Apache module. This module, called mod_mono, allows Apache to serve ASP.NET pages "by proxying the requests to a slightly modified version of XSP called mod-mono-server". mod-mono-server is installed when you install XSP. At the time of writing the current version of the mod_mono module for Apache only works for Apache on Linux and not for Apache on Windows. For this reason, when we look at ASP.NET on Apache in the Apache with mod_mono section we only look at it in the context of Linux. If you do wish to serve ASP.NET content from Apache on Windows have a look at this article[^] on CP, which shows how to use configure Apache to use Cassini to serve ASP.NET content or have a look at the Apache HTTP CLI[^] project. What you need to knowThis article assumes that you have Mono installed and working on your desired platform. The first article in this series, Introduction to Mono - Your first Mono app[^], explains how to get Mono up and running on Windows and Linux so if you have not yet done so have a look over that article. I also assume that you are familiar with ASP.NET and the semantics of ASP.NET programming as this article primarily looks at getting ASP.NET working with XSP and Apache, not at ASP.NET programming. Lets get XSP up and runningIn this section we will look at getting XSP up and running on both Windows and on Linux. Installing and running on Windows is "tackled" first simply because I want to get it out of the way and because chances are that you already have XSP on Windows considering the fact that you should have Mono already installed. Then it's on to Linux and getting XSP up and running there. To be honest, if you already have Mono running on Linux, which you should as it's one of the prerequisites for this article, then it should be relatively easy. XSP on WindowsThe first article[^] in this series ran through installing Mono on Windows. It mentioned that during the install process the installer gives you the option to select which components to install. By default, XSP is installed along with Mono but if you decided to not install XSP during the install then the easiest way to get XSP installed is to uninstall Mono and then reinstall it again. Here are the steps explaining how to install Mono and XSP on a Windows 2000 or above machine:
Those of you who read the first article will notice that I more or less ripped the instructions from that one... I'm not lazy, just no point in rewriting what has already been said! The next step in using XSP on Windows is to run it. The Running XSP section explains how to run the XSP web server and looks at some of the command line options that you can use to alter it's default behaviour. XSP on LinuxAs with installing Mono on Linux, which we examined in the previous article, things are slightly more complicated on Linux then on Windows. However, as I already mentioned, if you have Mono installed, then getting XSP installed is going to be a breeze for you. I'm installing XSP on the same systems that I used for installing Mono in the previous article. A quick recap of what exactly I used is in order so: I used Microsoft Virtual PC 2004 and created two identical virtual PCs. I then installed SuSE 9.2 Professional with ACPI disabled and I used the default package selection when installing. In the last article I went through how to install Mono using the pre-built packages from the Mono site and also I ran through how to install Mono from source. So for the purposes of this article I will be installing XSP on a SuSE 9.2 Professional with the default package selection with Mono 1.0.5 installed along with any additional packages or programs that were installed during the Mono install. In this article we will again look at installing from both the pre-build packages and from the source. XSP using pre-built packagesAs I am sure you can remember from the first article (if you read it that is), installing using the pre-built packages from the Mono site is one of the easiest ways of getting Mono up and running. The same thing applies to getting XSP up and running. So, head on over to the Mono download page (http://www.mono-project.com/downloads/index.html[^]) and see if there are pre-built packages for your particular Linux distribution or if there are packages for a distribution that you know will be compatible with your distribution. If there isn't a package that will work with your distribution just jump ahead to the XSP from source section where I will run through installing XSP from the source which is a simple process. Lets get going:
At this stage XSP should be installed on your system so you can jump ahead to the Running XSP section which gives an overview of how to use XSP. If you are having difficulty installing XSP from the packages have a look at the next section, "XSP from source", which might be able to help you out. XSP from sourceInstalling XSP from the source should be breeze if you have installed Mono from source by following the instructions in the previous article[^]. Let's jump straight in:
Congratulations. You should not have the XSP web server installed on your system. The next section looks at how to run and use the XSP web server. Running XSPXSP should be installed on your preferred platform at this stage so now we will look at how to start XSP and we will also look at the different command line options you can use to modify the default behaviour of the server. Running XSP ASP.NET ExamplesStarting XSP with the ASP.NET examples that come with it is a bit of a no-brainer on both Linux and Windows, well, it is with the version 1.0.5 of XSP that I am using:
On both Windows and Linux you should get output similar to the following on your screen: Listening on port: 8080
Listening on address: 0.0.0.0
Root directory: /usr/share/doc/xsp/test
Hit Return to stop the server.
The above output is from starting XSP on Linux using the steps above. The main difference you will notice in the output from Windows is that the port that the server is listening on will probably be port 8088, which is the default port used by the Mono installer on Windows. You will also notice that the Root Directory will probably be something like C:\PROGRA~1\MONO-1~1.5\share\doc\xsp\test. Regardless of the output, if XSP has started successfully simply fire up your browser and point it to http://localhost:<port num> where <port num> is the port number that is listed at the end of the the Listening on port: line of the output. On Linux you would generally use http://localhost:8080 and on Windows you would use http://localhost:8088. When the browser loads you should be presented with a web page similar to the one shown in Figure 1 below.
The page shown in Figure 1 is the home page of the example ASP.NET site that comes with XSP. It has numerous examples of ASP.NET Web Forms and ASP.NET Web Services. XSP, close up.The information in the section above shows how to start the examples website that comes with the XSP web server. However, chances are high that you will want to use the web server for actually serving your own web applications and Web Services. To this end we will now look at the command line options that you can use to modify the default behaviour of XSP. However, before doing that I want to point out where the XSP web server itself is located on both Linux and Windows:
Now, on to the command line options for XSP, or to be more exact, for xsp.exe:
So, what does the above boil down to? Well, the easiest way to explain is to show some example command lines so here goes:
Now that we have looked at XSP it's time to move on to getting Apache serving ASP.NET pages. If you don't care about ASP.NET on Apache then you could always skip ahead to the Some Examples section where I run through a simple ASP.NET example. ASP.NET on Apache with mod_monoApache is the web server of choice on Linux and is, according to netcraft[^], the most widely used web server on the net. This means that there are lots of websites out there that could be serving ASP.NET web applications and hosting ASP.NET Web Services. Mono makes this possible in the form of the mod_mono module for Apache which makes use of XSP or, to be more specific, it makes use of mod-mono-server.exe which is a specialized version of XSP. In this section we will look at installing mod_mono and how to get Apache serving ASP.NET content. However, before we do that, we need to get Apache installed. As this article is aimed more at how to get Apache serving and hosting ASP.NET content I will quickly run over getting Apache installed. If you run into any difficulty when trying to install Apache just search the web for instructions on how to install Apache on your particular Linux distribution. Oh, and one more thing. As I mentioned in the What are XSP and mod_mono? section, mod_mono currently does not work with Apache on Windows so I only look at Apache on Linux from here on. Installing ApacheAs with most things on Linux there are a number of different ways to install applications. In the case of Apache I'm just going to install from source as it is probably one of the easiest ways to install Apache and it is also the most distribution independent way of installing it that I know of. If you already have Apache 1.3.x or greater installed then you can skip ahead to the Installing and configuring mod_mono section. So, lets get Apache installed:
At this stage you should have Apache installed. To start the Apache web server type
Now that we have Apache installed it's time to install mod_mono and configure Apache to host and serve ASP.NET content. Installing and configuring mod_monoOk. We're nearly there. Apache should be up and running by now so we don't have too much left to do. We need to install mod_mono and then configure Apache in order to make it send the requests that we want through the mod_mono module and on to the mod-mono-server.exe application that will handle the request. As with Apache, I'm gong to run through installing mod_mono from the source. Before we actually go ahead and install mod_mono I should mention that there are some prerequisites to installing. You must have Mono installed, you must have XSP installed, and you must have Apache installed. If you've been following this article, and the previous article, then you should already have your system configured as needed. Now, lets see if we can get mod_mono installed:
That should have been painless. You should have mod_mono installed on your system now. So what's left to do? Well, we need to configure Apache to use mod_mono to handle requests. This means we need to edit the Apache config files. If you have installed Apache following the instructions in the Installing Apache section the Apache config file should be the following file: Firstly, we need to configure Apache to load the mod_mono module. To do this we need to edit the Apache config file, /usr/conf/httpd.conf, and add the following line to the end: LoadModule mono_module /usr/modules/mod_mono.so
The above line tells Apache to load the module located at /usr/modules/mod_mono.so as the mono module. The next thing that we need to do it configure Apache to serve some ASP.NET content. We will use the same ASP.NET Examples that we used with the XSP server above. To do this we need to tell Apache to serve content from the /usr/share/doc/xsp/test/ directory for a given path, lets say, /AspNetOnApache. This means that when you browse to http://localhost/AspNetOnApache you will be served the ASP.NET content in the /usr/share/doc/xsp/test/ directory. Here are the additions you need to make to the Apache config file: Alias /AspNetOnApache "/usr/share/doc/xsp/test"
MonoApplications "/AspNetOnApache:/usr/share/doc/xsp/test"
Finally, we need to tell Apache which module to use as the handler for requests. For Apache 1.3.x you can use: <Directory /usr/share/doc/xsp/test>
SetHandler mono
<IfModule mod_dir.c>
DirectoryIndex index.aspx
</IfModule>
</Directory>
and for Apache 2.0.x you can use the above text OR you can use the following <Location /AspNetOnApache>
SetHandler mono
</Location>
Finally! We are there. Simply go to the console and type the command
Some ExamplesSo after all that you should be able to serve ASP.NET content from at least one server on Linux. Just to help round off the "experience" I've decided to add a basic web application example to this article. A simple web application exampleOur simple web application is very simple indeed. It consists of a single page that displays some basic information about the machine that the page is hosted on and also some basic information about the request for the page. There are two files, index.aspx and index.aspx.cs, the former being the web page and the latter being the codebehind file for that page. So open up your favourite text editor or IDE and create the two files (hint: copy and paste is probably the quickest way): index.aspx<%@ Page language="c#" src="introtomono2/index.aspx.cs"
Inherits="SimpleWebApp.SimplePage" AutoEventWireup="false"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" >
<HTML>
<HEAD>
<title>Simple Page</title>
</HEAD>
<body>
<form method="post" runat="server">
<table width="450px" border="1px">
<tr>
<td colspan="2"><strong>Server Details</strong></td>
</tr>
<tr>
<td>Server Name:</td>
<td>
<asp:Label id="serverName" runat="server"></asp:Label></td>
</tr>
<tr>
<td>Operating System:</td>
<td>
<asp:Label id="operatingSystem" runat="server"></asp:Label>
</td>
</tr>
<tr>
<td>Operating System Version:</td>
<td>
<asp:Label id="operatingSystemVersion" runat="server">
index.aspx.csusing System;
using System.Web.UI.WebControls;
namespace SimpleWebApp
{
public class SimplePage : System.Web.UI.Page
{
protected Label operatingSystem;
protected Label operatingSystemVersion;
protected Label requestedPage;
protected Label requestIP;
protected Label requestUA;
protected Label serverName;
protected override void OnLoad(EventArgs e)
{
DisplayServerDetails();
DisplayRequestDetails();
base.OnLoad (e);
}
private void DisplayServerDetails()
{
serverName.Text = Environment.MachineName;
operatingSystem.Text = Environment.OSVersion.Platform.ToString();
operatingSystemVersion.Text = Environment.OSVersion.Version.ToString();
}
private void DisplayRequestDetails()
{
requestedPage.Text = Request.Url.AbsolutePath;
requestIP.Text = Request.UserHostAddress;
requestUA.Text = Request.UserAgent;
}
}
}
Once you have saved these two files we now need to be able to serve it. I saved the files to /home/bdelahunty/mono/webappexample/ and we now need to configure both XSP and Apache to serve pages from this location. As this is a simple web application example lets call it SimpleWebApp. To get XSP to serve the page use the following command at the console (replacing /home/bdelahunty/mono/webappexample/ with the directory where you saved the files): xsp --applications /SimpleWebApp:/home/bdelahunty/mono/webappexample/
To get Apache to serve the page simply add the following to the end of the Apache config file, /usr/conf/httpd.conf in my case (replacing /home/bdelahunty/mono/webappexample/ with the directory where you saved the files): Alias /SimpleWebApp "/home/bdelahunty/mono/webappexample" MonoApplications "/SimpleWebApp:/home/bdelahunty/mono/webappexample" You also need to add the following if you are using Apache 1.3.x: <Directory /home/bdelahunty/mono/webappexample>
SetHandler mono
<IfModule mod_dir.c>
DirectoryIndex index.aspx
</IfModule>
</Directory>
and for Apache 2.0.x you can use the above text OR you can use the following: <Location /SimpleWebApp>
SetHandler mono
</Location>
Now just fire up your browser and point it to http://localhost/SimpleWebApp for Apache or http://localhost:8080/SimpleWebApp for XSP and you should see a page similar to the one shown in Figure 4.
Problems with the Visual Studio .NET and IIS way?If you are used to developing ASP.NET web applications with Visual Studio .NET then there are a few things you need to watch out for. When creating aspx pages Visual Studio .NET used the You may or may not have noticed that I used the If you are used to the Visual Studio .NET and IIS way, or if you simply use Visual Studio .NET to build your web applications and want to just drop the pre-compiled dll into the bin directory then you can quickly overcome the problem by deploying your new dll and then restarting the web server. Use What next?Well hopefully this article has helped you to get some ASP.NET pages served from a Linux machine running XSP or Apache (and of course from XSP on Windows) and that it has given you a basic overview of using XSP and mod_mono. The next article in this "Introduction to Mono" series will either look at how you can get the latest version of Mono at any time using CVS or how to develop some GUI applications using Mono. NoteWhen this article was written the latest stable version of Mono was 1.0.5. However, at the time of posting this article the latest stable version is 1.0.6. Links
HistoryMarch 3rd, 2005 - First Posted.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||