Просмотр исходного кода

gitleaks allow docs (#941)

* gitleaks allow docs

* reorder
Zachary Rice 3 лет назад
Родитель
Сommit
31a8e9db7a
1 измененных файлов с 11 добавлено и 1 удалено
  1. 11 1
      README.md

+ 11 - 1
README.md

@@ -356,9 +356,19 @@ stopwords = [
   '''endpoint''',
 ]
 ```
-
 Refer to the default [gitleaks config](https://github.com/zricethezav/gitleaks/blob/master/config/gitleaks.toml) for examples or follow the [contributing guidelines](https://github.com/zricethezav/gitleaks/blob/master/README.md).
 
+### Additional Configuration
+If you are knowingly committing a test secret that gitleaks will catch you can add a `gitleaks:allow` comment to that line which will instruct gitleaks
+to ignore that secret. Ex:
+```
+class CustomClass:
+    discord_client_secret = '8dyfuiRyq=vVc3RRr_edRk-fK__JItpZ'  #gitleaks:allow
+
+```
+
+
+
 ## Secured by Jit
 
 We use [Jit](https://www.jit.io/jit-open-source-gitleaks?utm_source=github&utm_medium=readme&utm_campaign=GitleaksReadme&utm_id=oss&items=item-secret-detection) to secure our codebase, to achieve fully automated, full-stack continuous security using the world's best OSS security tools.