Skip to content

Commit

Permalink
Add documentation for .tsh/config/config.yml (#11531)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex McGrath authored Apr 5, 2022
1 parent ef2ae6f commit 759d752
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/pages/setup/reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -688,6 +688,30 @@ Environment variables configure your tsh client and can help you avoid using fla
| TELEPORT_ADD_KEYS_TO_AGENT | Specifies if the user certificate should be stored on the running SSH agent | yes, no, auto, only |
| TELEPORT_USE_LOCAL_SSH_AGENT | Disable or enable local SSH agent integration | true, false |

### tsh configuration file

`tsh` has an optional configuration file that is stored in `$TELEPORT_HOME/config/config.yaml`.

The `tsh` configuration file enables you to specify HTTP headers to be
included in requests to Teleport Proxy Servers with addresses matching
the `proxy` field.

```yaml
add_headers:
- proxy: "*.example.com" # matching proxies will have headers included
headers: # headers are pairs to include in the http headers
foo: bar # Key/Value to be included in the http request
```
Adding HTTP headers may be useful, if for example an intermediate HTTP
proxy is in place that requires setting an authentication token:
```yaml
add_headers:
- proxy: "*.infra.corp.xyz"
headers:
"Authorization": "Bearer tokentokentoken"
```
## tctl
Expand Down

0 comments on commit 759d752

Please sign in to comment.