Skip to content

Commit ab8aa6b

Browse files
committed
Add README for OAuth2 client sample
1 parent facf16c commit ab8aa6b

File tree

1 file changed

+12
-0
lines changed
  • spring-boot-samples/spring-boot-sample-oauth2-client

1 file changed

+12
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
= Spring Boot Sample OAuth2 Client
2+
3+
== Register Github OAuth2 application
4+
To run the sample, you need to link:https://github.com/settings/applications/new[register an OAuth application on Github].
5+
While registering your application, ensure the Authorization callback URL is set to http://localhost:8080/oauth2/authorize/code/github.
6+
After completing the registration, you will have a new OAuth Application with a Client ID and Client Secret.
7+
8+
== Configuring application.yml
9+
Once the OAuth application is registered with GitHub, you need to configure the sample application to use this OAuth application (client).
10+
Edit the link:src/main/resources/application.yml[application.yml] and replace ${APP-CLIENT-ID} and ${APP-CLIENT-SECRET} with the OAuth client credentials created in the previous section.
11+
12+
The sample can now be run and you can login with your Github user credentials.

0 commit comments

Comments
 (0)