From 8420b255e0ce8b8c610e7a197b6bf961c672c95c Mon Sep 17 00:00:00 2001 From: sickprodigy Date: Sat, 22 Nov 2025 18:20:40 -0500 Subject: [PATCH] docs: update README for clarity and structure improvements --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 52 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a699e2e..6da44df 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,60 @@ -# Beets Music Management Configs and file Examples Using Docker/Portainer +# Beets Music Management: Docker & Portainer Guide -Hello everyone, I struggled with beets and figured I'd share a bit of information here for others to find and maybe explain some concepts behind them and how to use. -most of the configs and files above are well commented. So be sure to read through those first. THIS IS STILL IN TESTING PHASE, but is somewhat working without tearing up your library this way. -I generally use lidarr arr-scripts to manage my music library. Here is where I got with my testing. +Welcome! +I struggled with Beets setup and wanted to share my configs, tips, and troubleshooting for anyone else working on music management with Docker and Portainer. -How I'm running beats: +--- + +## Quick Start + +**Tested On:** - Debian 12 - Docker -- Docker Compose (Optional- I just use it to spin up portainer) -- Portainer Business Edition (Optional- people say to not to use it, only reason I can see is random issues that pop up like this container can't be deleted or stack is stuck, does get annoying) +- Docker Compose *(optional, for Portainer stacks)* +- Portainer Business Edition *(optional; note: can be buggy with stuck containers/stacks)* -Note: things that say (redacted) must be replaced with your own api keys. +> **Note:** +> Replace anything marked `(redacted)` with your own API keys. -Discord if you need help: https://discord.gg/9xzTtCxauJ +--- -Feel free to open an issue with questions. +## How I Use Beets -Problems I couldn't solve: -- Why is spotify the only indexer showing up after running for x amount of time? While I still have dns access to the musicbrainz. weird block? would rather stop the software from running if can't reach ANY/ALL site/s, so I can get the best of what is available. -- How to use multi-indexers for genres combining them instead of using 1 site or the other. WLG is broken, could push PR for a method -- Exporting to .lrc file so navidrome and/or plex can read the lyrics while playing. Only options were .pdf x and y +- Most configs and example files are well-commented—please read through them first! +- I use Lidarr arr-scripts to manage my music library. +- This setup is still in **testing phase**, but works without damaging your library. + +--- + +## Help & Community + +- **Discord:** [Join for help or discussion](https://discord.gg/9xzTtCxauJ) +- **Issues:** Feel free to [open an issue](../../issues) with questions or suggestions. + +--- + +## Unsolved Problems + +- **Spotify as Only Indexer:** + After running for a while, only Spotify shows up as an indexer, even with DNS access to MusicBrainz. Is this a block? + *Would prefer Beets to stop if it can't reach all indexers, to ensure best results.* + +- **Multi-Indexer Genre Combining:** + How to combine genres from multiple sites instead of using just one? + *WLG is broken—could submit a PR for a better method.* + +- **Exporting Lyrics (.lrc):** + Want to export to `.lrc` for Navidrome/Plex lyric support. + *Currently, only `.pdf` export is available.* + +--- + +## Tips + +- Read through all config files for comments and explanations. +- Use Docker Compose for easier stack management, but be aware of Portainer quirks. +- Always backup your music library before testing new configs. + +--- + +*Happy tagging and organizing!* \ No newline at end of file