add Readme

This commit is contained in:
2024-01-10 04:24:58 +01:00
parent 77b9243649
commit fd722ac48e
2 changed files with 23 additions and 2 deletions

23
README.md Normal file
View 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

View File

@@ -4,8 +4,6 @@ const app = express();
const port = process.env.PORT || 9000; const port = process.env.PORT || 9000;
let tokenData;
app.use((req, res, next) => { app.use((req, res, next) => {
console.log(`[${new Date().toLocaleString()}] ${req.method} ${req.url}`); console.log(`[${new Date().toLocaleString()}] ${req.method} ${req.url}`);
next(); next();