aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEllie Huxtable <ellie@elliehuxtable.com>2023-08-19 12:28:39 +0100
committerGitHub <noreply@github.com>2023-08-19 12:28:39 +0100
commit73bd8015c3ba50ceb5168a8b67bb1ac5d3b48dc1 (patch)
tree0fe6dbe55a7dda6bd93a72fbfcb29e6f3993e95c /docs
parentUpdate dependencies (#1181) (diff)
downloadatuin-73bd8015c3ba50ceb5168a8b67bb1ac5d3b48dc1.zip
Automatically filter out secrets (#1182)
I'd like to extend the regex list here very soon, but start off by automatically filtering out secrets. Do not store them in history! I've included regex for: 1. AWS key id 2. Github pat (old and new) 3. Slack oauth tokens (bot, user) 4. Slack webhooks 5. Stripe live/test keys Will need updating after #806
Diffstat (limited to '')
-rw-r--r--docs/docs/config/config.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/docs/config/config.md b/docs/docs/config/config.md
index 50b1d7f2..e30ca2ae 100644
--- a/docs/docs/config/config.md
+++ b/docs/docs/config/config.md
@@ -250,6 +250,20 @@ history_filter = [
]
```
+### secrets_filter
+
+```
+secrets_filter = true
+```
+
+Defaults to true. This matches history against a set of default regex, and will not save it if we get a match. Defaults include
+
+1. AWS key id
+2. Github pat (old and new)
+3. Slack oauth tokens (bot, user)
+4. Slack webhooks
+5. Stripe live/test keys
+
## macOS <kbd>Ctrl-n</kbd> key shortcuts
macOS does not have an <kbd>Alt</kbd> key, although terminal emulators can often be configured to map the <kbd>Option</kbd> key to be used as <kbd>Alt</kbd>. *However*, remapping <kbd>Option</kbd> this way may prevent typing some characters, such as using <kbd>Option-3</kbd> to type `#` on the British English layout. For such a scenario, set the `ctrl_n_shortcuts` option to `true` in your config file to replace <kbd>Alt-0</kbd> to <kbd>Alt-9</kbd> shortcuts with <kbd>Ctrl-0</kbd> to <kbd>Ctrl-9</kbd> instead: