Skip to content
This repository was archived by the owner on Feb 19, 2026. It is now read-only.

Commit df001b8

Browse files
authored
Add Zvuk Music provider documentation (#79)
## Summary - Add documentation for the new Zvuk Music provider - Add Zvuk Music icon to assets ## Changes - `docs/music-providers/zvuk.md` - Provider documentation including: - Feature table with supported capabilities - Token-based authentication instructions - Audio quality settings - Known issues and limitations - `docs/assets/icons/zvuk-icon.svg` - Provider icon ## Related This documentation accompanies the Zvuk Music provider implementation. --- 🤖 Generated with [Claude Code](https://claude.ai/claude-code)
2 parents fe47678 + 7ff2a53 commit df001b8

2 files changed

Lines changed: 108 additions & 0 deletions

File tree

docs/assets/icons/zvuk-icon.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/music-providers/zvuk.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Zvuk Music ![Preview image](../assets/icons/zvuk-icon.svg){ width=50 align=right }
2+
3+
Music Assistant has support for [Zvuk Music](https://zvuk.com). Contributed and maintained by [TrudenBoy](https://github.com/TrudenBoy).
4+
5+
This provider is built on top of the [zvuk-music](https://github.com/trudenboy/zvuk-music) library.
6+
7+
!!! note
8+
A Zvuk Music subscription is required for lossless (FLAC) quality. Free accounts can stream at high quality (320 kbps) with limitations.
9+
10+
## Features
11+
12+
| | |
13+
|:-----------------------|:---------------------:|
14+
| Subscription FREE | Yes (with limitations) |
15+
| Self-Hosted Local Media | No |
16+
| Media Types Supported | Artists, Albums, Tracks, Playlists |
17+
| [Recommendations](../ui.md#view-home) Supported | No |
18+
| Lyrics Supported | No |
19+
| [Radio Mode](../ui.md#track-menu) | No |
20+
| Maximum Stream Quality | Lossless FLAC (with subscription) |
21+
| Login Method | Token |
22+
23+
### Other
24+
25+
- Searching the Zvuk Music catalogue is possible
26+
- Items in a users Zvuk Music library will be synced to Music Assistant
27+
- Adding/removing items to/from the Music Assistant library will sync back to Zvuk Music
28+
- Playlist creation and editing is supported
29+
30+
## Configuration
31+
32+
Configuration requires obtaining an X-Auth-Token from Zvuk Music.
33+
34+
### Obtaining the Token
35+
36+
The Zvuk Music provider requires an authentication token (X-Auth-Token) from your Zvuk account.
37+
38+
**Steps:**
39+
40+
1. **Log in** to your Zvuk Music account at [zvuk.com](https://zvuk.com) using your web browser
41+
42+
2. **Navigate** to the profile API endpoint: [https://zvuk.com/api/tiny/profile](https://zvuk.com/api/tiny/profile)
43+
44+
Your browser will display a JSON response containing your profile information and authentication token.
45+
46+
3. **Locate the token** in the JSON response
47+
48+
The response will look similar to this:
49+
50+
```json
51+
{
52+
"user": {
53+
"id": 12345678,
54+
"email": "your@email.com",
55+
"token": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
56+
...
57+
}
58+
}
59+
```
60+
61+
4. **Copy the token value**
62+
63+
- Find the line with `"token":` in the JSON
64+
- Copy only the alphanumeric string between the quotes (not including the quotes)
65+
- The token is typically a long string of random letters and numbers
66+
- Example token: `abc123def456ghi789jkl012mno345pqr678stu901vwx234yz`
67+
68+
5. **Paste the token** into Music Assistant
69+
70+
- Go to Music Assistant Settings → Music Providers → Zvuk Music
71+
- Paste the token into the "X-Auth-Token" field
72+
- Save the configuration
73+
74+
!!! tip "Browser Display Tips"
75+
- **Chrome/Edge**: JSON will be formatted automatically for easy reading
76+
- **Firefox**: JSON appears with syntax highlighting
77+
- **Safari**: Enable Develop menu → Show Page Source if needed
78+
- **Other browsers**: If the browser downloads a file, open it with a text editor
79+
80+
!!! warning "Token Security"
81+
Keep your token private and do not share it. Anyone with your token can access your Zvuk Music account.
82+
83+
### Settings
84+
85+
- **Audio quality**: Select preferred audio quality
86+
- `High (320 kbps)` - Available for all accounts (default)
87+
- `Lossless (FLAC)` - Requires a Zvuk Music subscription
88+
89+
## Known Issues / Notes
90+
91+
### Authentication Issues
92+
93+
- **Token expiration**: The token may expire and need to be refreshed periodically. If you encounter authentication errors, try obtaining a new token by following the steps above.
94+
- **Login required**: You must be logged in to zvuk.com before accessing the profile endpoint. If you see an error or empty response, make sure you're logged in to your account first.
95+
- **Invalid token format**: Ensure you copied the complete token value without any extra spaces, quotes, or line breaks.
96+
97+
### Quality Issues
98+
99+
- If lossless quality is unavailable (no subscription), the provider will automatically fall back to the highest available quality (320 kbps)
100+
101+
## Not yet supported
102+
103+
- Recommendations and personalized content
104+
- Lyrics display
105+
- Radio mode

0 commit comments

Comments
 (0)