Canopy 3.8.3 documentation

Hello and welcome to the documentation for Canopy!

From this overview page you’ll be able to find useful information on getting the most out of and administering Canopy. Here you can find the main overview.

Installation

How to install Canopy

User guide

Here you will find lots of useful information about key Canopy concepts and how to use Canopy.

Building document templates

Here you will find information for setting up report and statement of work templates for document generation.

Administration guide

Here you will find the necessary information for installing, configuring and maintaining Canopy.

Extending Canopy

Here you will find information for extending Canopy through the API and plugin system.

Support tickets

If you need to open a support ticket, please see our customer support ticketing system at https://checksec.zendesk.com.

Contents:

• Release notes for Canopy 3.8
  • 3.8.3 (2023-08-11)
  • 3.8.2 (2023-04-06)
  • 3.8.1 (2022-12-16)
  • 3.8.0 (2022-11-09)
  • Older releases
• User guide
  • About Canopy
  • Key concepts
  • Getting started
  • Logging in
  • Dashboard
  • Clients
  • Opportunities
  • Projects
  • Phases
  • Findings
  • Assets
  • Examples
  • Methodology templates
  • Supported tools
  • Findings Knowledge Base
  • Message templates
  • Substitution variables
  • Working with Jira
  • Custom fields [TODO]
  • Methodologies [TODO]
  • Other concepts [TODO]
  • Phase scopes [TODO]
  • Peer review and quality assurance [TODO]
  • Report templates [TODO]
  • Reports [TODO]
  • Retesting phases [TODO]
  • Scoping questionnaires [TODO]
  • Statement of work templates [TODO]
  • Statements of work [TODO]
  • Taxonomy templates [TODO]
• Administration guide
  • Architecture and hardware requirements
  • Authentication
  • Backups and recovery
  • Canopy Client Portal configuration
  • Copy/Backup/Restore instance data and files
  • Database settings
  • Email notifications and messages
  • Field sets and Field configurations
  • Hardening [TODO]
  • Installation
  • Microsoft SQL Server
  • Oracle Database
  • Installing the report mapping plugin for Word [TODO]
  • OpenID Connect Authentication
  • Roles and permissions
  • SAML 2.0 authentication
  • Setup Canopy and Jira
  • Supported operating systems
  • Windows AD authentication (via LDAP)
• Extending Canopy
  • REST API
  • Integrations
  • Plugins
  • Installing plugins and management commands
  • Writing plugins
• Support
  • Reporting issues for support
  • Support process
  • Support Hours
  • Service Level Agreement
  • Supported releases
  • Supported operating environments
  • Security vulnerabilities and disclosure policy
• Building document templates
  • Report templates
  • Statement of work templates [TODO]
  • Requirements
  • Common terminology
  • Template creation guides

Canopy 3.8.3