Welcome to DejaCode’s documentation!

Welcome to the very start of your DejaCode journey!

Getting Started

• Installation
  • Run with Docker
  • Enterprise deployment
  • Local development installation
• Dataspace
  • Setting up your License Library
  • Managing Users in your Dataspace
  • User Permission Groups
  • Defining your Usage Policies
  • Assigning Usage Policies to licenses
  • Reviewing your Dataspace settings
  • Using your Component Catalog
  • Assigning Usage Policies to Components
  • Enable package scanning with your ScanCode.io server
  • Enable PurlDB service
  • Enable VulnerableCodeDB service
• Application Settings
  • Settings file
  • Job Queue and Workers
  • AboutCode integrations
  • LDAP Integration
  • Configuration examples
• FAQs
  • How can I download SBOM for my products?
  • How can I integrate DejaCode with my tools or applications?

Tutorial

• Tutorial 1 - Your first Product
• Tutorial 2 - Working with Packages
• Tutorial 3 - Working with Reports
• Tutorial 4 - Managing Product Vulnerabilities
• Tutorial 5 - Working with SBOMs in a Product
• Tutorial 6 - Create a Product Vulnerability Report
• Tutorial 7 - Managing Policy Violations
• Tutorial 8 - Vulnerability Triage

How-To

• How To 1 - Manage your Usage Policies
• How To 2 - Take Advantage of Reference Data
• How To 3 - Downloading SBOM for Your Products
• How To 4 - Product Vulnerability Analysis
• How To 5 - Product Object Permissions
• How To 6 - Configure Policy Rules
• How To 7 - Configure Vulnerability Triage

Reference

• Models reference
• Vulnerability Management
• Policy Rules Engine
• Vulnerability Triage Engine
• Reference 1 - Declared License Expression and License Clarity Scoring
• Reference 2 - Understand the Package URL (purl) in DejaCode
• Reference 3 - CRAVEX support in DejaCode

Integrations

• Integrations overview
• Forgejo Integration
• GitHub Integration
• GitLab Integration
• Jira Cloud Integration
• SourceHut Integration
• REST API Integration
• Webhook integration

Miscellaneous

• Contributing to DejaCode
• Release notes
• Document Maintenance

Tutorial Documents

Tutorial documents provide specific instructions to help you get started.

• Tutorial 1 - Your first Product

• Tutorial 2 - Working with Packages

• Tutorial 3 - Working with Reports

How-To Documents

How-To documents explain how to accomplish specific tasks.

• How To 1 - Manage your Usage Policies

• How To 2 - Take Advantage of Reference Data

Reference Documents

Reference documents describe application concepts in depth.

• Reference 1 - Declared License Expression and License Clarity Scoring

• Reference 2 - Understand the Package URL (purl) in DejaCode

Indices and Tables

• Index

• Module Index

• Search Page