aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2019-11-27 11:29:09 -0500
committerJesse Luehrs <doy@tozt.net>2019-11-27 11:29:09 -0500
commita7ebc62a80933a73eae2282827e74dfaeb107820 (patch)
treeab3c9972f36926e67961eb09e23a700cba7479c2 /README.md
parenta7b13be27b7398c84296ef82ba60b7a441a3fb0f (diff)
downloadteleterm-a7ebc62a80933a73eae2282827e74dfaeb107820.tar.gz
teleterm-a7ebc62a80933a73eae2282827e74dfaeb107820.zip
calculate the redirect_url for web oauth too
a bit more complicated because it needs to use the configured public_address, etc
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4bdf079..66ed19a 100644
--- a/README.md
+++ b/README.md
@@ -169,9 +169,6 @@ need to configure separate OAuth applications for `cli` and `web` since the
* OAuth client id. Required.
* `client_secret`
* OAuth client secret. Required.
-* `redirect_url`
- * OAuth client redirect url. Required if `<client>` is `web`, and must be
- the `/oauth` path at the externally reachable domain of your web server.
#### `[client]` (used by `tt stream` and `tt watch`)
@@ -213,6 +210,20 @@ need to configure separate OAuth applications for `cli` and `web` since the
* Name of the TTYrec file to save to or read from.
* Default: `teleterm.ttyrec`
+### OAuth
+
+`tt` expects OAuth applications to be configured with specific values for the
+`redirect_url` setting. In particular:
+
+* For `cli`, the `redirect_url` should be exactly
+ `http://localhost:44141/oauth`.
+* For `web`, the `redirect_url` should be
+ `<scheme>://<public_address>/oauth/<method>`, where `<scheme>` is either
+ `http` or `https` depending on whether your web server has TLS enabled,
+ `<public_address>` is the `public_address` value configured in the `[web]`
+ section, and `<method>` is the authentication method (currently only
+ `recurse_center` is supported here).
+
## Troubleshooting
### I'm trying to watch someone and the output is a garbled mess!