Enterprise Web API Documentation

Installing Revelio

Revelio has the following prerequisites:

  • Microsoft Windows with IIS
  • .NET Framework 4.5.1
  • SQL database - Microsoft SQL Server or MySQL
  • Internet connection

If your server meets these requirements, then you can download the latest version of Revelio and begin the install process.

Configuring the Database

Revelio requires a database connection to either MSSQL or MySql. We strongly recommend that you provision a new database for Revelio to avoid any conflicts with other systems. Once you or your database administrator has created the database, make note of the connection information. You'll need to enter a connection string later.

Configuring IIS

In IIS, you'll want to create a new application pool for Revelio. Right-click the "Application Pools" menu item and select "Add Application Pool". You can enter any name you want, but the framework version needs to be v4.0 or above, pipeline needs to be set to "Integrated", and the application pool needs to run as "NetworkService" (or any user with permission to write to the registry).

You will need to create a new site or application for your Revelio installation. To create a new site, right-click the "Sites" folder and select "Add Website". To add an application, right-click the existing site and select "Add Application". In both of these scenarios, you will need to select the application pool you just created and the directory where you will extract the files (e.g. C:\inetpub\wwwroot\Revelio)

Application pool settings

Once IIS is set up, you can extract the Revelio zip file to the directory you configured in IIS (e.g. C:\inetpub\wwwroot\Revelio).

Upgrade Information

If you are upgrading an existing installation, you should be able to extract the files over top of the existing files.

Post-install Configuration

After you've completed all these steps, you can navigate to the new site in your browser. You'll then be walked the following steps:

  • Enter database type and connection string
  • Deploy database changes
  • Enter license information (view your account for your license key)

That's it! You can now publish your documentation to Revelio.