mirror of
https://github.com/JuLi0n21/osu-progress-oauth-helper.git
synced 2026-04-19 16:00:06 +00:00
add Readme
This commit is contained in:
23
README.md
Normal file
23
README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Osu Oauth Middleware Server hosted on Vercel
|
||||
Route access token back to end user without them needing own Api credentials!
|
||||
|
||||
# How to use:
|
||||
1. Fork Repo
|
||||
2. Deploy on Vercel
|
||||
3. Create [Api Client](https://osu.ppy.sh/home/account/edit#oauth) use the Vercel Domain as Callback
|
||||
4. add Envoirment variables
|
||||
- SCOPE: [scopes](https://osu.ppy.sh/docs/index.html#scopes)
|
||||
- CALLBACK_URL: localy hosted endpoint to where the access_token should be send to
|
||||
- URL: vercel Domain
|
||||
- PORT: Vercel server Port / default is 9000
|
||||
- CLIENT_ID: client_id
|
||||
- CLIENT_SECRET: client_secret
|
||||
|
||||
5. Add link to the vercel domain with port as state to /authoritze:
|
||||
https://example.vercel.app/authorize?port=4200
|
||||
|
||||
6. recieive anser at:
|
||||
https://localhost:4200/{CALLBACK_URL}?access_token={access_token}&refresh_token={refresh_token}&expires_in={expires_in}
|
||||
7. profit?
|
||||
|
||||
## use at own risk, security holes might be in there
|
||||
Reference in New Issue
Block a user