-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for the tsh config file #11531
Conversation
47dfd65
to
9e1c3d9
Compare
aafdc40
to
020e0be
Compare
headers: # headers are pairs to include in the http headers | ||
foo: bar # Key/Value to be included in the http request | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be great to include an example of when you would use custom HTTP headers in Proxy requests. For example, we could talk about the use case of sending traffic through intermediary proxies that require opaque auth tokens in HTTP headers (https://github.com/gravitational/teleport/pull/9475/files).
Otherwise, users may not know whether this config file is useful for their setup.
Also, are there any values of headers
that users should avoid?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, are there any values of headers that users should avoid?
I'm not aware of any, there doesnt seem to be anything else modifying headers in the webclient code either, so I think all values should be okay
020e0be
to
1eae53d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm with a couple suggestions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved with two minor comments
1eae53d
to
c943723
Compare
c943723
to
a609317
Compare
tsh config file support was added here: #10336
The following syntax is supported