phlaym/moshing-mammut
1
0
Fork 0
Code Issues 4 Pull Requests Projects Releases 8 Activity

add documentation for youtube playlist integration

Browse Source
This commit is contained in:
Max Nuding
2025-07-01 20:22:57 +02:00
parent b7a930c69a
commit 317f4d7fba
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -98,7 +98,7 @@ and set your `User`, `Group`, `ExecStart` and `WorkingDirectory` accordingly.
Copy `.env.EXAMPLE` to `.env` and add your `YOUTUBE_API_KEY` and `ODESLI_API_KEY`. Copy `.env.EXAMPLE` to `.env` and add your `YOUTUBE_API_KEY` and `ODESLI_API_KEY`.
To obtain one follow [YouTube's guide](https://developers.google.com/youtube/registering_an_application) to create an To obtain one follow [YouTube's guide](https://developers.google.com/youtube/registering_an_application) to create an
_API key_. _API key_.
If `YOUTUBE_API_KEY` is unset, no playlist will be updated. Also, _all_ YouTube links will be treated as music videos, If `YOUTUBE_API_KEY` is unset _all_ YouTube links will be treated as music videos,
because the API is the only way to check if a YouTube link leads to music or something else. because the API is the only way to check if a YouTube link leads to music or something else.
If `ODESLI_API_KEY` is unset, your rate limit to the song.link API will be lower. If `ODESLI_API_KEY` is unset, your rate limit to the song.link API will be lower.
@ -106,10 +106,15 @@ If `ODESLI_API_KEY` is unset, your rate limit to the song.link API will be lower
Add `MASTODON_ACCESS_TOKEN` as well, see [Creating our application Add `MASTODON_ACCESS_TOKEN` as well, see [Creating our application
](https://docs.joinmastodon.org/client/token/#app) in the Mastodon documentation. ](https://docs.joinmastodon.org/client/token/#app) in the Mastodon documentation.
`read:statuses` is the only required scope. An access token will be displayed in your settings. Use that! `read:statuses` and `read:search` the only required scope. An access token will be displayed in your settings. Use that!
There are currently no plans to implement an actual authentication flow. There are currently no plans to implement an actual authentication flow.
If you want the app to save the songs it encounters into a playlist, YouTube requires OAuth 2.0 credentials.
Once again, follow [YouTube's guide](https://developers.google.com/youtube/registering_an_application) and the OAuth 2.0 described there
to obtain a clientId and clientSecret. Add the values as `YOUTUBE_CLIENT_ID` and `YOUTUBE_CLIENT_SECRET`.
Create a playlist and configure its ID as `YOUTUBE_PLAYLIST_ID`.
Run `npm run build` and copy the output folder, usually `build` to `$APP_DIR` on your server. Run `npm run build` and copy the output folder, usually `build` to `$APP_DIR` on your server.
#### On your server again #### On your server again
@ -125,6 +130,9 @@ Verify that everything is okay with `service moshing-mammut status`.
The app should now be reachable on http://localhost:3000 or whatever you configured your domain to be! The app should now be reachable on http://localhost:3000 or whatever you configured your domain to be!
If you want to add the songs available on YouTube to a playlist and have configured the environment variables to do so,
you now need to visit `/ytauth`, e.g. `http://localhost:3000/ytauth`. This will obtain the necessary access tokens from Google.
# Icons # Icons
Favicon is a combination of [speaker-line by remix icon](https://remixicon.com/icon/speaker-line) Favicon is a combination of [speaker-line by remix icon](https://remixicon.com/icon/speaker-line)