CodeScoring Documentation

CodeScoring documentation

Русский
English

Initializing search

Home
Functionality
Administrator guide
User guide
Changelog

CodeScoring Documentation

Home
Functionality
Functionality
Administrator guide
Administrator guide
- Admin guide
- On-premise installation and maintenance
  On-premise installation and maintenance
  - Installation requirements
  - Installation Methods
    Installation Methods
    
    Installation in Docker
    
    External database in Docker
    
    Installation in Kubernetes
  - Maintenance
    Maintenance
    
    Updating the system in Docker
    
    Upgrading PostgreSQL in Docker
    
    Backup
    
    Proxy usage
    
    Self signed SSL certificates
    
    Connecting to PostgreSQL/PgBouncer using TLS
    
    Analysis paths and exceptions
    
    Scripts for platform managing
    
    Installation variables
    
    Main services
    
    Troubleshooting
- Platform setup
  Platform setup
  - Activating system
  - Calculating number of authors
  - Access management
    Access management
    
    Managing user accounts
    
    Creating user groups
    
    Setting up LDAP
    
    Setting up OpenID Connect
User guide
User guide
- User guide
- General
  General
  - General
  - Configuring user profile
  - Security policies
    Security policies
    
    Managing policies
    
    Ignoring policies
    
    Policy results
  - Project setup
    Project setup
    
    Connecting to VCS
    
    Managing projects
  - Advanced setup
    Advanced setup
    
    Creating proprietors
    
    Setting up notifications
    
    Working with audit log
    
    Collecting metrics
    
    Setting up webhooks
    
    Working with API
  - Data feeds
    Data feeds
    
    General description
    
    Working with protestware feed
    
    Using Kaspersky OSS Threats Data Feed
    
    Integrating OSS Index
- CodeScoring.OSA
  CodeScoring.OSA
  - General description
  - Plugins for repositories
    Plugins for repositories
    
    Plugin for Nexus
    
    Plugin for JFrog
    
    Plugin for Sfera
  - Working with OSA in the platform
    Working with OSA in the platform
    
    Connecting a repository manager
    
    Connecting a container registry
    
    Configuring OSA policies
    
    Working with OSA components
    
    Updating component data
  - OSA Proxy
    OSA Proxy
    
    Overview
    
    Service deployment
    
    Service configuration
    
    Redis and сaching сonfiguration
    
    Supported protocols
    
    Metrics
    
    Base64 URL configuration
    
    Maven configuration
    
    npm configuration
    
    NuGet configuration
    
    PyPI configuration
    
    GO configuration
    
    Debian configuration
    
    Docker configuration
    
    Alpine (APK) configuration
    
    RPM configuration
- CodeScoring.SCA
  CodeScoring.SCA
  - General description
  - Analysis in the platform
    Analysis in the platform
    
    Launching a scan
    
    Overviewing dependencies
    
    Working with vulnerabilities
    
    Tracking scan history
    
    Exporting analysis results
    
    Organizing project groups
  - CLI agent Johnny
    CLI agent Johnny
    
    General description
    
    Using configuration file
    
    Setting environment variables
    
    Scan command
    
    Scanning a directory
    
    Scanning a file
    
    Scanning archives
    
    Scanning container images
    
    Scanning a C/C++ build
    
    Scanning a SBOM
    
    Scanning a technology
    
    Scanning for secrets
    
    Using reachability analysis
    
    Signing and verifying a SBOM
    
    Launching in Docker
    
    Integrating into Gitlab CI
    
    Integrating into Jenkins Pipeline
    
    Integrating into GitFlic CI
    
    Saving scan results
    
    Exporting scan results
    
    Resolving dependencies
  - IDE integrations
    IDE integrations
    
    General description
    
    VS Code plugin
    
    IntelliJ plugin
  - Working with dependencies
    Working with dependencies
    
    General description
    
    Java
    
    Scala
    
    Go
    
    JavaScript
    
    .NET
    
    PHP
    
    Python
    
    Ruby
- CodeScoring.Secrets
  CodeScoring.Secrets
  - General description
  - Configuration
    Configuration
    
    Setting up engine configuration
    
    Configuring VCS project for secret search
  - Secrets analysis
    Secrets analysis
    
    Launching secret search
    
    Searching secrets in CLI projects
    
    Working with findings
  - Managing ML Model
- CodeScoring.TQI
  CodeScoring.TQI
  - General description
  - Project analysis
    Project analysis
    
    Launching TQI analysis
    
    Viewing analysis results
    
    Tracking code clones
    
    Calculating technical debt metrics
  - Author analysis
    Author analysis
    
    Building author profiles
Changelog
Changelog

Русский

CodeScoring Documentation

In case of any questions please write to [email protected]

Admin guide User guide

Copyright © 2018 - CodeScoring

Made with Material for MkDocs