docs(muse): helmify docs (#32835)

**Description**
<!--
helmify docs
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [x] 📜 Documentation Changes

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [x] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made changes to the documentation
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning
- [x] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
This commit is contained in:
Boemeltrein
2025-03-03 22:27:25 +01:00
committed by GitHub
parent f396ce336d
commit 05c1247023
+6 -24
View File
@@ -2,31 +2,13 @@
title: Installation Notes
---
- `Discord Token` can be acquired [here](https://discordapp.com/developers/applications) by creating a 'New Application', then going to 'Bot'.
- `Spotify Client Id` and `Spotify Client Secret` can be acquired [here](https://developer.spotify.com/dashboard/applications) with 'Create a Client ID'.
- `Youtube API Key` can be acquired by [creating a new project](https://console.developers.google.com/) in Google's Developer Console, enabling the YouTube API, and creating an API key under credentials.
More information about the following `.Values.muse`:
- `discord.token` can be acquired [here](https://discordapp.com/developers/applications) by creating a 'New Application', then going to 'Bot' and press 'Reset Token'.
- `spotify.client.id` and `spotify.client.secret` can be acquired [here](https://developer.spotify.com/dashboard/applications) with 'Create a new app'
- `youtube.key` can be acquired by [creating a new project](https://console.developers.google.com/) in Google's Developer Console, enabling the YouTube API, and creating an API key under credentials.
Optionally you can enable the `advanced` settings and set the following:
Optionally you can set additional settings in the `.Values.muse.bot` en `.Values.muse.cache`. For more details check the `helm-release.yalm` and read the upstream documentation.
- `Cache Limit` can accept MB or GB string values for example: **512MB** or **10GB**.
- `Bot Status` has list of values for the discord bot:
- Online
- Away
- Do not Disturb
- `Bot Activity Type` has list of values for the discord bot:
- Playing
- Listening
- Watching
- Streaming
- Set `Bot Activity` to whatever you want that follows the activity type.
- If you plan to publicly share your bot with more servers other than your own, its recommended by the upstream project to set `Register Commands On Bot` to **true** if its more than 10 guilds. The bot is purpose built to support multiple servers.
:::note
If `Bot Activity Type` set to **Streaming** then `Bot Activity URL` will be shown and is required to be set by adding either a youtube or twitch stream url.
:::
Once installed, check the app logs to get the discord invite link that auto-generated and then invite the bot into your server.
Once deployed, check the chart logs to get the discord invite link that auto-generated and then invite the bot into your server.
The bot will play music only in voice channels.