mkdocs.yml

site_name: CodeScoring Documentation

# repo_url: https://gitlab.com/mkdocs-i18n/mkdocs-i18n
# edit_uri: ''

theme:
  name: material
  custom_dir: overrides
  language: ru
  logo: assets/codescoring_logo.png
  favicon: assets/favicon/favicon-32x32.png
  features:
    - navigation.tracking
    - navigation.indexes
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to dark mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to system preference
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to light mode

plugins:
  - search
  - print-site
  - i18n:
      languages:
        ru: "Русский"
        en: "English"
      default_language: 'ru'
      no_translation:
        ru: "Эта страница еще не переведена на русский язык."
        en: "This page has not yet been translated to English."
      translate_nav:
        en:
          main: "General"
          begin: "Beginning"
          functionality: "Functionality"
          integration-stages: "Integration stages"
          supported-package-managers: "Supported ecosystems and analysis methods"
          changelog: "Changelog"
          installation: "On-premise installation and maintenance"
          hardware: "Hardware requirements"
          installation-docker: "Installation in Docker"
          installation-kubernetes: "Installation in Kubernetes"
          update: "Updating the system in Docker"
          backup: "Backup"
          proxy: "Proxy usage"
          ssl: "Self signed SSL certificates"
          analysis-ignore-paths: "Analysis paths and exceptions"
          troubleshooting: "Troubleshooting"
          beginning: "Getting started with on-premise"
          activation: "Activation"
          proprietors: "Creating proprietors"
          vcs: "Connecting to VCS"
          repo-managers: "Connecting to repository managers"
          project-control: "Managing projects"
          policies: "Managing policies"
          launch-analysis: "Launching analysis"
          export-results: "Exporting analysis results"
          registries: "Connecting container registries"
          groups: "Creating user groups"
          users: "Managing user accounts"
          ldap: "Setting up LDAP"
          graph: "Visualizing dependency graph"
          notifications: "Setting up notifications"
          audit-log: "Working with audit log"
          metrics: "Collecting metrics"
          webhooks: "Setting up webhooks"
          api: "Working with API"
          osa: "CodeScoring OSA"
          osa-general: "General"
          nexus-osa: "Nexus OSA"
          jfrog-osa: "JFrog OSA"
          osa-policies: "OSA policies settings"
          osa-components: "OSA components"
          agent: "CLI agent Johnny"
          agent-general: "General"
          agent-config: "Configuration"
          agent-variables: "Setting environment variables"
          agent-scan: "Scan command"
          agent-scan-dir: "Scanning a directory"
          agent-scan-file: "Scanning a file"
          agent-scan-archive: "Scanning archives"
          agent-scan-docker: "Scanning container images"
          agent-scan-build: "Scanning a C/C++ build"
          agent-scan-bom: "Scanning a SBOM"
          agent-launch-docker: "Launching in Docker"
          agent-gitlab-ci: "Integrating into Gitlab CI"
          agent-jenkins: "Integrating into Jenkins Pipeline"
          agent-gitflic-ci: "Integrating into GitFlic CI"
          agent-save-results: "Saving scan results"
          agent-export: "Exporting scan results"
          agent-resolve: "Resolving dependencies"
          secrets: "CodeScoring Secrets"
          secrets-general: "General"
          secrets-setup: "Setting up engine configuration"
          secrets-vcs: "Configuring VCS project for secret search"
          secrets-launch: "Launching secret search"
          secrets-cli: "Importing report to a CLI project"
          secrets-findings: "Working with findings"
          secrets-model: "Managing ML Model"
          jfrog-changelog: "JFrog OSA"
          johnny-changelog: "CLI agent Johnny"
          nexus-changelog: "Nexus OSA"
          on-premise-changelog: "CodeScoring on-premise"

        ru:
          main: "Общая информация"
          begin: "Начало"
          functionality: "Функциональные характеристики"
          integration-stages: "Этапы интеграции"
          supported-package-managers: "Поддерживаемые экосистемы и способы анализа"
          changelog: "Changelog"
          installation: "Установка и эксплуатация"
          hardware: "Аппаратные требования"
          installation-docker: "Установка системы в Docker"
          installation-kubernetes: "Работа системы в Kubernetes"
          update: "Обновление системы в Docker"
          backup: "Резервное копирование"
          proxy: "Работа через прокси"
          ssl: "Самоподписанные SSL сертификаты"
          analysis-ignore-paths: "Пути анализа и исключения"
          troubleshooting: "Диагностика неполадок"
          beginning: "Начало работы с инсталляцией"
          activation: "Активация системы"
          proprietors: "Создание владельцев"
          vcs: "Подключение системы контроля версий"
          repo-managers: "Подключение менеджеров репозиториев"
          project-control: "Управление проектами"
          policies: "Настройка политик"
          launch-analysis: "Запуск анализа"
          export-results: "Выгрузка результатов анализа"
          registries: "Работа с Docker-образами"
          groups: "Создание групп пользователей"
          users: "Управление учетными записями"
          ldap: "Настройка LDAP"
          graph: "Визуализация графа зависимостей"
          notifications: "Настройка уведомлений"
          audit-log: "Работа с аудит-логом"
          metrics: "Сбор метрик"
          webhooks: "Подключение вебхуков"
          api: "Работа с API"
          osa: "CodeScoring OSA"
          osa-general: "Общее"
          nexus-osa: "Nexus OSA"
          jfrog-osa: "JFrog OSA"
          osa-policies: "Настройка политик OSA"
          osa-components: "Работа с компонентами OSA на инсталляции"
          agent: "Консольный агент Johnny"
          agent-general: "Общее"
          agent-config: "Настройка через конфигурационный файл"
          agent-variables: "Настройка через переменные окружения"
          agent-scan: "Команда сканирования"
          agent-scan-dir: "Сканирование директории"
          agent-scan-file: "Сканирование файла"
          agent-scan-archive: "Сканирование архивов"
          agent-scan-docker: "Сканирование контейнерных образов"
          agent-scan-build: "Сканирование сборки C/C++"
          agent-scan-bom: "Сканирование SBOM"
          agent-launch-docker: "Запуск с помощью Docker"
          agent-gitlab-ci: "Добавление в Gitlab CI"
          agent-jenkins: "Добавление в Jenkins"
          agent-gitflic-ci: "Добавление в GitFlic CI"
          agent-save-results: "Сохранение результатов сканирования"
          agent-export: "Экспорт результатов сканирования"
          agent-resolve: "Разрешение зависимостей в окружении сборки"
          secrets: "CodeScoring Secrets"
          secrets-general: "Общее"
          secrets-setup: "Создание конфигурации для поиска секретов"
          secrets-vcs: "Настройка VCS проекта для работы с секретами"
          secrets-launch: "Запуск поиска секретов"
          secrets-cli: "Загрузка отчета в CLI проект"
          secrets-findings: "Работа с найденными секретами"
          secrets-model: "Управление моделью машинного обучения"
          jfrog-changelog: "JFrog OSA"
          johnny-changelog: "Консольный агент Johnny"
          nexus-changelog: "Nexus OSA"
          on-premise-changelog: "CodeScoring on-premise"

nav:
  - main:
    - begin: index.md
    - begin: index.en.md
    - functionality: functionality.md
    - functionality: functionality.en.md
    - integration-stages: integration-stages.md
    - integration-stages: integration-stages.en.md
    - supported-package-managers: supported-package-managers.md
    - supported-package-managers: supported-package-managers.en.md
  - installation:
    - hardware: on-premise/server-requirements.md
    - hardware: on-premise/server-requirements.en.md
    - installation-docker: on-premise/installation.md
    - installation-docker: on-premise/installation.en.md
    - update: on-premise/update.md
    - update: on-premise/update.en.md
    - installation-kubernetes: on-premise/installation-in-k8s.md
    - installation-kubernetes: on-premise/installation-in-k8s.en.md
    - backup: on-premise/backup.md
    - backup: on-premise/backup.en.md
    - proxy: on-premise/proxy.md
    - proxy: on-premise/proxy.en.md
    - ssl: on-premise/self-signed-ssl.md
    - ssl: on-premise/self-signed-ssl.en.md
    - analysis-ignore-paths: on-premise/analysis-ignore-paths.md
    - analysis-ignore-paths: on-premise/analysis-ignore-paths.en.md
    - troubleshooting: on-premise/troubleshooting.md
    - troubleshooting: on-premise/troubleshooting.en.md
  - beginning:
    - activation: on-premise/how-to/activation.md
    - activation: on-premise/how-to/activation.en.md
    - users: on-premise/how-to/users.md
    - users: on-premise/how-to/users.en.md
    - groups: on-premise/how-to/groups.md
    - groups: on-premise/how-to/groups.en.md
    - proprietors: on-premise/how-to/proprietors.md
    - proprietors: on-premise/how-to/proprietors.en.md
    - vcs: on-premise/how-to/vcs-git.md
    - vcs: on-premise/how-to/vcs-git.en.md
    - repo-managers: on-premise/how-to/repo-managers.md
    - repo-managers: on-premise/how-to/repo-managers.en.md
    - project-control: on-premise/how-to/projects.md
    - project-control: on-premise/how-to/projects.en.md
    - policies: on-premise/how-to/policies.md
    - policies: on-premise/how-to/policies.en.md
    - launch-analysis: on-premise/how-to/launch-analysis.md
    - launch-analysis: on-premise/how-to/launch-analysis.en.md
    - export-results: on-premise/how-to/export-results.md
    - export-results: on-premise/how-to/export-results.en.md
    - registries: on-premise/how-to/registries.md
    - registries: on-premise/how-to/registries.en.md
    - ldap: on-premise/how-to/ldap-settings.md
    - ldap: on-premise/how-to/ldap-settings.en.md
    - graph: on-premise/how-to/graphs.md
    - graph: on-premise/how-to/graphs.en.md
    - notifications: on-premise/how-to/notifications.md
    - notifications: on-premise/how-to/notifications.en.md
    - audit-log: on-premise/how-to/audit-log.md
    - audit-log: on-premise/how-to/audit-log.en.md
    - metrics: on-premise/how-to/metrics.md
    - metrics: on-premise/how-to/metrics.en.md
    - webhooks: on-premise/how-to/webhooks.md
    - webhooks: on-premise/how-to/webhooks.en.md
    - api: on-premise/how-to/api.md
    - api: on-premise/how-to/api.en.md
  - osa:
    - osa-general: osa/index.md
    - osa-general: osa/index.en.md
    - nexus-osa: osa/nexus_osa.md
    - nexus-osa: osa/nexus_osa.en.md
    - jfrog-osa: osa/jfrog_osa.md
    - jfrog-osa: osa/jfrog_osa.en.md
    - osa-policies: osa/osa-policies.md
    - osa-policies: osa/osa-policies.en.md
    - osa-components: osa/components.md
    - osa-components: osa/components.en.md
  - agent:
    - agent-general: agent/index.md
    - agent-general: agent/index.en.md
    - agent-config: agent/config.md
    - agent-config: agent/config.en.md
    - agent-variables: agent/env-variables.md
    - agent-variables: agent/env-variables.en.md
    - agent-scan: agent/scan.md
    - agent-scan: agent/scan.en.md
    - agent-scan-dir: agent/scan-dir.md
    - agent-scan-dir: agent/scan-dir.en.md
    - agent-scan-file: agent/scan-file.md
    - agent-scan-file: agent/scan-file.en.md
    - agent-scan-archive: agent/scan-archive.md
    - agent-scan-archive: agent/scan-archive.en.md
    - agent-scan-docker: agent/scan-docker.md
    - agent-scan-docker: agent/scan-docker.en.md
    - agent-scan-build: agent/scan-build.md
    - agent-scan-build: agent/scan-build.en.md
    - agent-scan-bom: agent/scan-bom.md
    - agent-scan-bom: agent/scan-bom.en.md
    - agent-launch-docker: agent/launch-docker.md
    - agent-launch-docker: agent/launch-docker.en.md
    - agent-gitlab-ci: agent/gitlab-ci.md
    - agent-gitlab-ci: agent/gitlab-ci.en.md
    - agent-jenkins: agent/jenkins-pipeline.md
    - agent-jenkins: agent/jenkins-pipeline.en.md
    - agent-gitflic-ci: agent/gitflic-ci.md
    - agent-gitflic-ci: agent/gitflic-ci.en.md
    - agent-save-results: agent/save-results.md
    - agent-save-results: agent/save-results.en.md
    - agent-export: agent/export.md
    - agent-export: agent/export.en.md
    - agent-resolve: agent/resolve.md
    - agent-resolve: agent/resolve.en.md
  - secrets:
    - secrets-general: secrets/index.md
    - secrets-general: secrets/index.en.md
    - secrets-setup: secrets/secrets-setup.md
    - secrets-setup: secrets/secrets-setup.en.md
    - secrets-vcs: secrets/secrets-vcs.md
    - secrets-vcs: secrets/secrets-vcs.en.md
    - secrets-launch: secrets/secrets-launch.md
    - secrets-launch: secrets/secrets-launch.en.md
    - secrets-cli: secrets/secrets-cli.md
    - secrets-cli: secrets/secrets-cli.en.md
    - secrets-findings: secrets/secrets-findings.md
    - secrets-findings: secrets/secrets-findings.en.md
    - secrets-model: secrets/secrets-model.md
    - secrets-model: secrets/secrets-model.en.md
  - changelog:
    - on-premise-changelog: changelog/on-premise-changelog.md
    - on-premise-changelog: changelog/on-premise-changelog.en.md
    - johnny-changelog: changelog/johnny-changelog.md
    - johnny-changelog: changelog/johnny-changelog.en.md
    - nexus-changelog: changelog/nexus-changelog.md
    - nexus-changelog: changelog/nexus-changelog.en.md
    - jfrog-changelog: changelog/jfrog-changelog.md
    - jfrog-changelog: changelog/jfrog-changelog.en.md


copyright: Copyright &copy; 2018 - <script>document.write(new Date().getFullYear())</script> Profiscope

markdown_extensions:
  - attr_list
  - def_list
  - tables
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - toc:
        permalink: true

extra_css:
  - stylesheets/extra.css
  - css/hide_lang_links.css

extra:
  # Default mkdocs-material alternate links for untranslated pages
  # https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector
  # For translated pages the language name is replaced by the string configured in i18n plugin
  # section and link is replaced by the link to the translated page
  alternate:
    - name: "Русский"
      link: "/"
      lang: ru

    - name: "English"
      link: "/index.en/"
      lang: en
  i18n:
    - ru:
      site_name: "CodeScoring Documentation"
    - en:
      site_name: "CodeScoring Documentation"