aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2019-11-26 04:20:43 -0500
committerJesse Luehrs <doy@tozt.net>2019-11-26 04:20:43 -0500
commitea8beb985247aac4345ecefc8ec551f52f5f1a24 (patch)
tree7288af40b291e03252cfca7bb4654b63181776ed /README.md
parentcc5a3f9056fe1b563dbb40d51b1621769150c08d (diff)
downloadteleterm-ea8beb985247aac4345ecefc8ec551f52f5f1a24.tar.gz
teleterm-ea8beb985247aac4345ecefc8ec551f52f5f1a24.zip
allow multiple oauth configurations using the same auth type
this should allow us to configure a separate oauth application for tt web than normal (since the redirect_url needs to be different)
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index c797841..4bdf079 100644
--- a/README.md
+++ b/README.md
@@ -155,16 +155,23 @@ create one for you automatically. The configuration has several sections:
* Same as `uid`, except sets the user's primary group.
* Default: unset
-#### `[oauth.<method>]` (used by `tt server`)
+#### `[oauth.<method>.<client>]` (used by `tt server`)
-`<method>` corresponds to an OAuth-using login method - for instance, a section
-would be named something like `[oauth.recurse_center]`. Note that OAuth login
-methods are required to use `http://localhost:44141` as their redirect URL.
+`<method>` corresponds to an OAuth-using login method. Currently only
+`recurse_center` is supported. `<client>` describes what types of clients will
+be using this configuration. Currently valid values for `<client>` are `cli`
+(for `tt stream` and `tt watch`) and `web` (for `tt web`). For example, a valid
+configuration section will look like `[oauth.recurse_center.cli]`. You will
+need to configure separate OAuth applications for `cli` and `web` since the
+`redirect_url` will need to be different in each case.
* `client_id`
- * OAuth client id.
+ * OAuth client id. Required.
* `client_secret`
- * OAuth 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`)