Skip to content

[Feature Request]: Add a "Quick Start for Security Teams" section using test-pages examples #113

@ianderdvl

Description

@ianderdvl

Please confirm:

  • I have searched existing feature requests (open and closed) and found no duplicates.

Problem Statement

Hi! I'm working on a phishing-detection browser extension for a cybersecurity engineering course, and I’ve been reviewing Check as a reference for how a production-grade extension structures its rules, config, and deployment.

One thing that stood out is that Check already has great building blocks (rules, config, test-pages, enterprise deployment notes), but a short “Quick Start” aimed at security teams new to the project might make onboarding even easier.

Suggested documentation improvement

Under the “Installation” or “Configuration” sections, add a short “Quick Start for Security Teams” subsection that:

  • Shows a minimal path to evaluate Check in a lab:
    1. Clone the repo and load it as an unpacked extension.
    2. Open one of the pages under test-pages/ that simulates a Microsoft 365 phishing login.
    3. Confirm that Check’s block/warn behavior triggers as expected.
  • Mentions that this is a safe/demo way to show the extension to stakeholders without needing a live phishing campaign.

Why this might help

  • Many defenders want to quickly demo value to non-technical stakeholders (managers, clients) before investing time in policy tuning.
  • Surfacing the existing test-pages/ folder as the default demo path would make it easier to get that “wow, it actually blocks the fake login” moment.
  • It aligns nicely with the rest of the documentation that already focuses on real-world deployment and enterprise management.

Thanks for maintaining this project — it’s a very helpful example of a serious, production-quality phishing-detection extension.

Benefits for MSPs

A Quick Start section would help MSPs demonstrate the value of the phishing-protection extension faster and with less manual work. Right now, MSPs who want to test or show the extension to clients must set up their own phishing test pages or rely on live phishing attempts, which is inefficient and sometimes risky.

Highlighting the existing test-pages/ folder as a safe demonstration environment would:

  • Reduce manual work: MSPs could immediately validate policy behavior without creating their own test infrastructure.
  • Improve customizability: It gives MSPs a clear baseline test scenario before applying tenant-specific rules or policies.
  • Fill a coverage gap: There is currently no guided path for MSPs to quickly evaluate or proof-of-concept the extension in a demo or pilot environment.

This small documentation update would streamline the evaluation and onboarding process across multiple customers.

Value or Importance

This addition is valuable because MSPs frequently deploy tools across many tenants and need a fast, reliable way to validate functionality before rolling out security changes. A simple Quick Start section lowers the barrier to entry and helps them immediately see whether the extension is performing as expected.

Even though this is not a critical code change, it is a high-impact improvement to usability and onboarding. Many MSPs evaluate security tools by how quickly they can be tested, demonstrated, and explained to stakeholders. By surfacing the test-pages/ folder and turning it into a guided path, the project becomes easier to adopt and easier to recommend.

This strengthens trust in the tool, reduces friction in pilot deployments, and helps MSPs showcase phishing-protection behavior to clients with minimal setup.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions