Merge pull request #35 from antoineco/clarify-callback-path

Clarify path of the OAuth callback URL
benbjohnson · Feb 15, 2021 · aab552f · aab552f
2 parents be79ddb + 301c58a
commit aab552f
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -121,8 +121,12 @@ $ make
 $ go install ./cmd/...
 ```
 
-The `wtfd` server uses GitHub for authentication so you'll need to [create a 
-new GitHub OAuth App](https://github.com/settings/applications/new).
+The `wtfd` server uses GitHub for authentication so you'll need to [create a new
+GitHub OAuth App](https://github.com/settings/applications/new). Set the value
+of the authorization callback URL to `http://HOST[:PORT]/oauth/github/callback`,
+where `HOST[:PORT]` is the host name or IP address at which clients can access
+the `wtfd` server, with an optional port number (e.g. `localhost:3000` when
+running locally).
 
 Next, you'll need to setup a configuration file in `~/wtfd.conf`: