Getting Started

To get up and running with Glimpse is pretty simple. Together we are going to have a look at getting this up and running for you.

NOTE: Glimpse docs are currently being improved. If you'd like to help out, just edit this page or contribute to our GitHub Wiki

Overview

Getting Glimpse up and running couldn't be easier:

1. Download

Use Visual Studio to get your desired packages

2. Enable

Go to /glimpse.axd and enable Glimpse to run

3. Using

Navigate around your site and start using Glimpse

Download

Visual Studio & NuGet

The best way to download and install Glimpse is via NuGet. The quickest way to get up and running is by choosing from the below packages and installing them via Visual Studio or Command Line.

Source Code

Want to download the latest source for Glimpse?

Latest source on GitHub

Whether you use NuGet or manually install Glimpse, the DLL's Glimpse needs to run will be referenced by your project and added to your bin folder. From here, for your first run, all you need is to enable Glimpse and start using it.

Packages

Glimpse has many different extensions and plugins. Together with the community, there are some truly amazing extensions and extras you can get your hands on.

Choose which packages to install

Out of the box here is where you will probably want to get started:

Which web framework you using?

WebForms  
PM> Install-Package Glimpse.WebForms
or
MVC  
PM> Install-Package Glimpse.MVC5

What about Data Access?

Raw ADO  
PM> Install-Package Glimpse.ADO
or
Entity Framework  
PM> Install-Package Glimpse.EF5

Note that if you are using a different version of MVC/EF, use that instead – e.g. MVC2, MVC3, MVC4, EF43, or EF6

...and many more can be found in the Glimpse Extension Gallery

Enable

Glimpse is designed to be secure by default. This means that unless you tell Glimpse otherwise, you can only access Glimpse from localhost.

Note, this means that you wont be able to access Glimpse remotely whilst policy is in place.

Visit Glimpse.axd

By installed Glimpse, this page is made available as an extensions your site. It becomes the point through which you can see how glimpse is setup and some helper buttons to work with the policies that are shipped out of the box.

By triggering the "Turn Glimpse On" button, the page will confirm that Glimpse is now listening to requests.

Returning Home

Once "Turned on" you will now see glimpse appear in the bottom right hand corner of your screen.

From this point, you can mouse over the various sections or open Glimpse up fully by clicking on the Glimpse icon.

Using Glimpse

Once you’ve enabled Glimpse on the server and the client, the Glimpse Heads-Up Display appears in the lower right corner of your web application.

Heads-Up Display

HUD is how Glimpse shows you the most important information, when you need it, without you needing to ask for it; all right in the bottom of your page.

It brings together information from both the client and server, to provide a complete picture of your request. This is something very few systems can provide, let alone in your browser.

Main Panel

From the HUD, you can dive down into another level of information by clicking on the "G" in the lower right corner. When the Main Panel opens you will be presented with a series of tabs which offer a range of insights into your application.

These tabs are easily selectable and your selected tab is remembered between redirects. Additional tabs will be added to your setup if and when you add additional packages

Observe

HUD updates its data as you move from page to page

Detail

Hover over any one of the sections for more details

Open

Click on the "G" icon on the right to open the Main Panel

Switch

Select the various tabs you are interested in at any time

Configuration

When Glimpse is installed via NuGet, any configuration details are setup by default. What it does for you is adds a custom section called <glimpse> in your web.config file.

Most of the time you wont have to make many chances here, but if you are interested in black listing or removing Tab or various Security policies the Glimpse configuration system makes this easy:

Additional Help

If you need more help, try the following resources:

  • Issue List - Found a problem? Report it on the GitHub Issue Tracker.
  • Mailing List - Creating a plugin or want to keep up with the latest Glimpse developments? Sign up for our Developers List.
  • Stack Overflow - Have a question? Ask away on StackOverflow, using the glimpse tag.
  • Blog - Want to keep up on the latest Glimpse news? Check out the blog.
  • Troubleshooting - Having trouble? See if our troubleshooting page can help.

More Information