Skip to content

Commit a711296

Browse files
committed
Merge branch 'card/add-default-configuration-engine' into 'master'
Добавление описания настройки конфигурации движка секретов по умолчанию See merge request CodeScoring/docs!598
2 parents 043be68 + e091fac commit a711296

6 files changed

Lines changed: 42 additions & 2 deletions
31.9 KB
Loading
43.7 KB
Loading
28.1 KB
Loading
39.2 KB
Loading

docs/secrets/secrets-setup.en.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
hide:
33
- footer
44
---
5+
56
# Setting up engine configuration
67

78
1. To start working with the Secrets module, you must first create a VCS or CLI [project](/on-premise/how-to/projects) in the `Settings -> Projects` section.
@@ -21,4 +22,23 @@ useDefault = true
2122

2223
![Engine configuration example](/assets/img/secrets/engine-configuration.png)
2324

24-
More details on configuring the gitleaks engine can be found in the [tool documentation](https://github.com/gitleaks/gitleaks?tab=readme-ov-file#configuration).
25+
More details on configuring the gitleaks engine can be found in the [tool documentation](https://github.com/gitleaks/gitleaks?tab=readme-ov-file#configuration).
26+
27+
## Setting up default engine configuration
28+
29+
To set the default configuration you need to click the **Use by default** button in the configuration settings.
30+
31+
![Set default engine configuration example](/assets/img/secrets/secrets-set-default-engine-config.png)
32+
33+
!!! warning "Editing the default configuration"
34+
You cannot set more than one default configuration, nor can you delete a configuration that is set as default.
35+
36+
To use the default configuration for a project check the **Use default** flag in the **Secrets** section of the project settings. The configuration currently used by default will be shown in parentheses.
37+
38+
![Set default engine configuration in project example](/assets/img/secrets/secrets-set-default-engine-config-in-project.png)
39+
40+
!!! warning "Changing default configuration"
41+
When setting a new default configuration, all projects with the **Use default** flag selected will use the new configuration.
42+
43+
!!! note "Configuration secrets engine for the new project"
44+
When creating a new project, a default engine configuration is automatically set. This configuration can be changed in the project settings in the **Secrets** section.

docs/secrets/secrets-setup.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
hide:
33
- footer
44
---
5+
56
# Создание конфигурации для поиска секретов
67

78
1. Для начала работы с модулем Secrets необходимо предварительно создать VCS или CLI [проект](/on-premise/how-to/projects) в разделе `Настройки -> Проекты`.
@@ -21,4 +22,23 @@ useDefault = true
2122

2223
![Engine configuration example](/assets/img/secrets/ru-engine-configuration.png)
2324

24-
Подробнее с конфигурированием движка gitleaks можно ознакомиться в [документации инструмента](https://github.com/gitleaks/gitleaks?tab=readme-ov-file#configuration).
25+
Подробнее с конфигурированием движка gitleaks можно ознакомиться в [документации инструмента](https://github.com/gitleaks/gitleaks?tab=readme-ov-file#configuration).
26+
27+
## Создание конфигурации движка секретов по умолчанию
28+
29+
Для задания конфигурации по умолчанию необходимо в настройках конфигурации нажать на кнопку **Установить по умолчанию**.
30+
31+
![Set default engine configuration example](/assets/img/secrets/ru-secrets-set-default-engine-config.png)
32+
33+
!!! warning "Редактирование конфигурации по умолчанию"
34+
Нельзя установить более одной конфигурации по умолчанию, а также удалить используемую по умолчанию конфигурацию.
35+
36+
Для использования в проекте конфигурации по умолчанию необходимо в настройках проекта в разделе **Секреты** установить чек-бокс **По умолчанию**. В круглых скобках будет указана конфигурация, используемая в данный момент по умолчанию.
37+
38+
![Set default engine configuration in project example](/assets/img/secrets/ru-secrets-set-default-engine-config-in-project.png)
39+
40+
!!! warning "Изменение конфигурации по умолчанию"
41+
При установке новой конфигурации по умолчанию во всех проектах, где установлен чек-бокс **По умолчанию**, будет использована новая установленная конфигурация.
42+
43+
!!! note "Конфигурация движка секретов у нового проекта"
44+
При создании нового проекта для сканирования секретов автоматически будет установлена конфигурация по умолчанию. Конфигурацию можно изменить в настройках проекта в разделе **Секреты**.

0 commit comments

Comments
 (0)