From aa8fdb4acadd5b59b317d1ead903916bcaaf1023 Mon Sep 17 00:00:00 2001 From: Branson <141467667+bransoned@users.noreply.github.com> Date: Sat, 17 Jan 2026 11:01:29 -0500 Subject: [PATCH] Update README Updated README to reflect the new name 'Octo-Fiestarr' and added SquidWTF support details. --- README.md | 77 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 46 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 0038683..011ff0c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Octo-Fiesta +# Octo-Fiestarr A Subsonic API proxy server that transparently integrates multiple music streaming providers as sources. When a song is not available in your local Navidrome library, it is automatically fetched from your configured provider, downloaded, and served to your Subsonic-compatible client. The downloaded song is then added to your library, making it available locally for future listens. -## Why "Octo-Fiesta"? +## Why "Octo-Fiestarr"? -The name was randomly generated by GitHub when creating the repository. We found it amusing and somewhat fitting for a music application — after all, "fiesta" evokes a party atmosphere, which goes well with music streaming. So we kept it! +This fork was created to focus on integrating the original concept of Octo-Fiesta with music providers that do not require API credentials, such as SquidWTF. This allows for seamless external music discovery without the need for any subscriptions. Thus, I saw it fitting to change the name of the fork to resemble other *arr projects. ## Features @@ -12,8 +12,8 @@ The name was randomly generated by GitHub when creating the repository. We found - **Transparent Proxy**: Acts as a middleware between Subsonic clients (like Aonsoku, Sublime Music, etc.) and your Navidrome server - **Seamless Integration**: Automatically searches and streams music from your configured provider when not available locally - **Automatic Downloads**: Songs are downloaded on-the-fly and cached for future use -- **External Playlist Support**: Search, discover, and download playlists from Deezer and Qobuz with automatic M3U generation -- **Hi-Res Audio Support**: Qobuz provider supports up to 24-bit/192kHz FLAC quality +- **External Playlist Support**: Search, discover, and download playlists from Deezer, Qobuz, and SquidWTF with automatic M3U generation +- **Hi-Res Audio Support**: SquidWTF provider supports up to 24-bit/192kHz FLAC quality - **Full Metadata Embedding**: Downloaded files include complete ID3 tags (title, artist, album, track number, year, genre, BPM, ISRC, etc.) and embedded cover art - **Organized Library**: Downloads are saved in a clean `Artist/Album/Track` folder structure - **Artist Deduplication**: Merges local and streaming provider artists to avoid duplicates in search results @@ -37,6 +37,7 @@ The name was randomly generated by GitHub when creating the repository. We found ### iOS - [Narjo](https://www.reddit.com/r/NarjoApp/) +- [Arpeggi](https://www.reddit.com/r/arpeggiApp/) > **Want to improve client compatibility?** Pull requests are welcome! @@ -48,6 +49,7 @@ These clients are **not compatible** with octo-fiesta due to architectural limit ## Supported Music Providers +- **[SquidWTF](https://tidal.squid.wtf/)** - Quality: FLAC (Hi-Res 24-bit/192kHz & CD-Lossless 16-bit/44.1kHz), AAC - **[Deezer](https://www.deezer.com/)** - Quality: FLAC, MP3_320, MP3_128 - **[Qobuz](https://www.qobuz.com/)** - Quality: FLAC, FLAC_24_HIGH (Hi-Res 24-bit/192kHz), FLAC_24_LOW, FLAC_16, MP3_320 @@ -56,7 +58,7 @@ Choose your preferred provider via the `MUSIC_SERVICE` environment variable. Add ## Requirements - A running Subsonic-compatible server (developed and tested with [Navidrome](https://www.navidrome.org/)) -- Credentials for at least one music provider: +- Credentials for at least one music provider (IF NOT USING SQUIDWTF): - **Deezer**: ARL token from browser cookies - **Qobuz**: User ID + User Auth Token from browser localStorage ([see Wiki guide](https://github.com/V1ck3s/octo-fiesta/wiki/Getting-Qobuz-Credentials-(User-ID-&-Token))) - Docker and Docker Compose (recommended) **or** [.NET 9.0 SDK](https://dotnet.microsoft.com/download/dotnet/9.0) for manual installation @@ -78,8 +80,8 @@ The easiest way to run Octo-Fiesta is with Docker Compose. # Path where downloaded songs will be stored on the host DOWNLOAD_PATH=./downloads - # Music service provider (Deezer or Qobuz) - MUSIC_SERVICE=Qobuz + # Music service provider (SquidWTF, Deezer, or Qobuz) + MUSIC_SERVICE=SquidWTF # === External Playlists (optional) === ENABLE_EXTERNAL_PLAYLISTS=true # Enable/disable playlist support (default: true) @@ -115,9 +117,15 @@ The easiest way to run Octo-Fiesta is with Docker Compose. | Setting | Description | |---------|-------------| | `Subsonic:Url` | URL of your Navidrome/Subsonic server | -| `Subsonic:MusicService` | Music provider to use: `Deezer` or `Qobuz` (default: `Deezer`) | +| `Subsonic:MusicService` | Music provider to use: `SquidWTF`, `Deezer`, or `Qobuz` (default: `SquidWTF`) | | `Library:DownloadPath` | Directory where downloaded songs are stored | +### SquidWTF Settings + +| Setting | Description | +|---------|-------------| +| `SquidWTF:Quality` | Preferred audio quality: `FLAC`, `MP3_320`, `MP3_128`. If not specified, the highest available quality for your account will be used | + ### Deezer Settings | Setting | Description | @@ -136,7 +144,7 @@ The easiest way to run Octo-Fiesta is with Docker Compose. ### External Playlists -Octo-Fiesta supports discovering and downloading playlists from your streaming providers (Deezer and Qobuz). +Octo-Fiesta supports discovering and downloading playlists from your streaming providers (SquidWTF, Deezer, and Qobuz). | Setting | Description | |---------|-------------| @@ -144,7 +152,7 @@ Octo-Fiesta supports discovering and downloading playlists from your streaming p | `Subsonic:PlaylistsDirectory` | Directory name where M3U playlist files are created (default: `playlists`) | **How it works:** -1. Search for playlists from Deezer or Qobuz using the global search in your Subsonic client +1. Search for playlists from an external provider using the global search in your Subsonic client 2. When you "star" (favorite) a playlist, Octo-Fiesta automatically downloads all tracks 3. An M3U playlist file is created in `{DownloadPath}/playlists/` with relative paths to downloaded tracks 4. Individual tracks are added to the M3U as they are played or downloaded @@ -210,26 +218,33 @@ If you prefer to run Octo-Fiesta without Docker: Edit `octo-fiesta/appsettings.json`: ```json - { - "Subsonic": { - "Url": "http://your-navidrome-server:4533", - "MusicService": "Qobuz" - }, - "Library": { - "DownloadPath": "./downloads" - }, - "Qobuz": { - "UserAuthToken": "your-qobuz-token", - "UserId": "your-qobuz-user-id", - "Quality": "FLAC" - }, - "Deezer": { - "Arl": "your-deezer-arl-token", - "ArlFallback": "", - "Quality": "FLAC" - } - } - ``` +{ + "Subsonic": { + "Url": "https://navidrome.local.bransonb.com", + "MusicService": "SquidWTF", + "ExplicitFilter": "All", + "DownloadMode": "Track", + "StorageMode": "Permanent", + "CacheDurationHours": 1 + }, + "Library": { + "DownloadPath": "./downloads" + }, + "Qobuz": { + "UserAuthToken": "your-qobuz-token", + "UserId": "your-qobuz-user-id", + "Quality": "FLAC" + }, + "Deezer": { + "Arl": "your-deezer-arl-token", + "ArlFallback": "", + "Quality": "FLAC" + }, + "SquidWTF": { + "Quality": "FLAC" + } +} +``` 4. **Run the server** ```bash