search

Kentico / KInspector

KInspector is an application for analyzing health, performance and security of your Kentico solution.
MIT License
56 stars 63 forks source link
analysis health-check kentico kentico-cms kentico-ems performance-analysis security-audit

readme

Kentico Inspector

Join the chat at https://kentico-community.slack.com Build first-timers-only Github All Releases

Kentico Inspector (formerly KInspector) is an application for analyzing the health, performance and security of Kentico EMS solutions.

Kentico Inspector was initially developed as an internal application by the Kentico consulting team to help evaluation customer's web sites. We quickly realized that the broader community would benefit from this as well, so we made it open source.

The application is Kentico version agnostic and has no dependencies on version-specific DLLs. Most modules are designed to support version 10 and later, but some will work on older versions as well.

Running Kentico Inspector

You can download the latest release and extract the contents to a local directory to use console or IIS mode.

:round_pushpin: Note:

The application needs permission to create/modify files in the directory it is run from to save instances to a file.

Or, you can clone this repository and follow these instructions to run the application locally.

Console mode

Console mode is useful if you just want to quickly run the tool occasionally. To use console mode, run KenticoInspector.WebApplication.exe and open your browser to either https://localhost:5001 or http://localhost:5000.

IIS mode

IIS mode allows you to have the tool always available, for example, on a development server. To use IIS mode, point your IIS directory to the folder you extracted everything to and make sure the application pool's .NET CLR version is set to No managed code. Open the site in your browser.

Contributing

Want to improve the Kentico Inspector? Great! Read the contributing guidelines and then check out the open issues (especially issues marked as "good first issue") to get started.

If anything feels wrong or incomplete, please let us know. Create a new issue or submit a pull request.

Local development

Requirements

All versions below are from a known working environment. Lower versions may work but are not tested.

First run

Even if you don't plan to make any changes in the Client UI application, you'll need to build it before your first run and any time the client code is updated. To build the Client UI application:

Frontend build instructions

  1. Open Powershell/Command Prompt
  2. Change the directory to ./KenticoInspector.WebApplication/ClientApp
  3. Run npm i
  4. Run npm run build

Backend build instructions

  1. Open KInspector.sln in Visual Studio
  2. Do a build
  3. Make sure the KenticoInspector.WebApplication project is the start up project
  4. You can run it with either the IIS Express or Console debug launch settings

If you want to work on the Client UI applicaiton without running npm run build any time the code changes, you can set up an automatic build process:

  1. Open Powershell/Command Prompt
  2. Change the directory to ./KenticoInspector.WebApplication/ClientApp
  3. Run npm i (if you haven't already)
  4. Run npm run serve
  5. Leave the terminal open
  6. Follow the steps to build the backend, but run it using the UI Development debug launch settings.
    • This runs the backend with a proxy to the running instance you started in Powershell and allows you to take advantage of the hot-reloading of the client application