Skip to content

Commit 93e2695

Browse files
josselinondutyjosselinonduty
committed
chore: improve quick start session and UX; add section about login in FAQ; small tweaks
1 parent 25bdcbe commit 93e2695

1 file changed

Lines changed: 88 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 88 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,58 @@ It packages the app in a number of formats:
2020

2121
## Installation
2222

23-
You can find all of the packages on [the release page](https://github.com/aunetx/deezer-linux/releases/latest).
23+
> [!TIP]
24+
> The easiest way to install is from **Flathub** or the **Snap Store**. One click, automatic updates, and it works on any distro. Just pick a button below.
2425
25-
To install the flatpak version, you can simply go to https://flathub.org/apps/dev.aunetx.deezer (or use your favorite flatpak package manager).
26+
<div align="center">
2627

27-
Other packages can be installed from your package manager, either by clicking on them or from the command-line.
28+
<a href="https://flathub.org/apps/dev.aunetx.deezer">
29+
<img height="60" alt="Get it on Flathub" src="https://flathub.org/api/badge?svg&locale=en">
30+
</a>
31+
&nbsp;&nbsp;
32+
<a href="https://snapcraft.io/deezer-desktop">
33+
<img height="60" alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg">
34+
</a>
35+
36+
</div>
37+
38+
### Which package should I choose?
39+
40+
| Method | Best for | How to get it |
41+
| ------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
42+
| **Flatpak**\* | Sandboxed, auto-updated, works everywhere | [**Install from Flathub**](https://flathub.org/apps/dev.aunetx.deezer) or `flatpak install flathub dev.aunetx.deezer` |
43+
| **Snap**\* | Ubuntu and Snap-based distros | [**Install from the Snap Store**](https://snapcraft.io/deezer-desktop) or `sudo snap install deezer-desktop` |
44+
| **AppImage** | A single portable file, no installation needed | [Download from the releases page](https://github.com/aunetx/deezer-linux/releases/latest) |
45+
| **`.deb`** | Debian, Ubuntu, Pop!\_OS, elementary OS… | [Download from the releases page](https://github.com/aunetx/deezer-linux/releases/latest) |
46+
| **`.rpm`** | Fedora, Red Hat, CentOS, openSUSE… | [Download from the releases page](https://github.com/aunetx/deezer-linux/releases/latest) |
47+
| **`.tar.xz`** | Any other distro. Set up and run | [Download from the releases page](https://github.com/aunetx/deezer-linux/releases/latest) |
48+
49+
All packages for every release are listed on the [**releases page**](https://github.com/aunetx/deezer-linux/releases/latest).
50+
51+
**\*** Flatpak and Snap packages are sandboxed, which means they have limited access to your system. This is a security feature, but it can cause some issues with certain features. You may have to grant additional permissions to the app using **[Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal)** (for Flatpak) or `snap connect` (for Snap).
52+
53+
### Using the AppImage
54+
55+
An AppImage is a single, portable file: mark it executable and run it. Because it is not integrated into your desktop environment on its own, we recommend managing it with a helper so you get a proper app icon and menu entry:
56+
57+
- [**Gear Lever**](https://github.com/mijorus/gear-lever): a modern GUI to install, update and manage AppImages ([also on Flathub](https://flathub.org/apps/it.mijorus.gearlever))
58+
- [**AppImageLauncher**](https://github.com/TheAssassin/AppImageLauncher): integrates AppImages into your system on first launch
59+
60+
> [!NOTE]
61+
> Prefer to register the AppImage manually instead of using a helper? See the [detailed steps below](#appimage). If login does not redirect back to the app, see the [FAQ](#the-browser-doesnt-launch-the-app-after-login-how-do-i-log-in-manually).
62+
63+
### Launching the app
64+
65+
After installing, launch **Deezer** from your applications menu, or from a terminal:
66+
67+
| Installed via | Command |
68+
| -------------------- | ------------------------------------------------------------------- |
69+
| Flatpak | `flatpak run dev.aunetx.deezer` |
70+
| Snap | `deezer-desktop` |
71+
| `.deb` / `.rpm` | `deezer-desktop` |
72+
| `.tar.xz` / AppImage | `./deezer-desktop` (from the extracted folder or the AppImage file) |
73+
74+
You can tweak how the app behaves with the [launch options](#usage) below (start in tray, sync theme, disable animations, and more).
2875

2976
## Usage
3077

@@ -36,7 +83,7 @@ Other packages can be installed from your package manager, either by clicking on
3683
| `--hide-offline-banner` | Hide the "Application is offline" banner that appears when using a VPN or DNS blocker (see [patch](./patches/08-hide-offline-banner.patch)) |
3784
| `--disable-animations` | Disable animations (see [patch](./patches/09-disable-animations.patch)) |
3885
| `--disable-notifications` | Disable notifications (see [patch](./patches/10-disable-notifications.patch)) |
39-
| `--sync-theme` | Sync the app's theme (dark/light) to the OS theme (see [patch](./patches/15-sync-theme.systempatch)) |
86+
| `--sync-theme` _\*_ | Sync the app's theme (dark/light) to the OS theme (see [patch](./patches/15-sync-theme.systempatch)) |
4087
| `--disable-hardware-acceleration` | Disable hardware acceleration (useful for systems with GPU issues) (see [patch](./patches/13-disable-hardware-acceleration.patch)) |
4188
| `--log-level` | Set the log level (`silly`,`debug`,`verbose`,`info`,`warn`,`error`) (see [patch](./patches/06-control-log-level.patch)) |
4289
| `--enable-wayland-ime` `--ozone-platform-hint=auto` `--wayland-text-input-version=3` | Enable IME keyboard support on Wayland |
@@ -50,11 +97,13 @@ Other packages can be installed from your package manager, either by clicking on
5097
| `DZ_HIDE_OFFLINE_BANNER` | `yes`,`no` | Hide the "Application is offline" banner (see [patch](./patches/08-hide-offline-banner.patch)) |
5198
| `DZ_DISABLE_ANIMATIONS` | `yes`,`no` | Disable animations (see [patch](./patches/09-disable-animations.patch)) |
5299
| `DZ_DISABLE_NOTIFICATIONS` | `yes`,`no` | Disable notifications (see [patch](./patches/10-disable-notifications.patch)) |
53-
| `DZ_SYNC_THEME` | `yes`,`no` | Sync the app's theme to the OS theme (see [patch](./patches/15-sync-theme.patch)) |
100+
| `DZ_SYNC_THEME` _\*_ | `yes`,`no` | Sync the app's theme to the OS theme (see [patch](./patches/15-sync-theme.patch)) |
54101
| `DZ_DISABLE_HARDWARE_ACCELERATION` | `yes`,`no` | Disable hardware acceleration (see [patch](./patches/13-disable-hardware-acceleration.patch)) |
55102
| `DZ_RESOURCES_PATH` | _path_ | Override the default resources path (see [patch](./patches/14-override-resources-path.patch)) |
56103
| `DZ_DEVTOOLS` | `yes`,`no` | Enable the developer console (ctrl+shift+i) |
57104

105+
_\*_ This feature does not work on Flatpak because of strict sandboxing.
106+
58107
## Building from source
59108

60109
### Available targets
@@ -65,8 +114,8 @@ Other packages can be installed from your package manager, either by clicking on
65114
| deb | ⚠️ | ✅ |
66115
| rpm | ⚠️ | ✅ |
67116
| tar.xz | ⚠️ | ✅ |
68-
| snap | ⚠️ | ✅ |
69-
| flatpak | ⚠️ | ✅ |
117+
| snap | ✅ | ✅ |
118+
| flatpak | ✅ | ✅ |
70119

71120
✅ Available ; ⚠️ Not tested ; ❌ Not available ; ⛔ Not planned
72121

@@ -75,7 +124,7 @@ Other packages can be installed from your package manager, either by clicking on
75124
76125
### Requirements
77126

78-
- Node.js (22+ recommended)
127+
- Node.js (24+ recommended)
79128
- npm (or yarn, see [FAQ](#i-want-to-use-yarn-instead-of-npm-is-it-possible))
80129
- 7z (try installing `p7zip` and `p7zip-full`)
81130
- make
@@ -103,17 +152,7 @@ make build_appimage_x64
103152
Artifacts will be generated in `artifacts/x64`.
104153

105154
> [!WARNING]
106-
> You _may_ encounter a problem with the AppImage, where you are not able to login. This is a known issue, and is due to the way AppImage works. In this case, you can copy the link shown in `https://www.deezer.com/desktop/login/electron/callback`.
107-
>
108-
> In the same directory as the AppImage file, use:
109-
>
110-
> ```sh
111-
> deezer-desktop-*.AppImage deezer://autolog/...
112-
> ```
113-
>
114-
> You should now be logged in.
115-
>
116-
> For more information, see [issue #29](https://github.com/aunetx/deezer-linux/issues/29)
155+
> You _may_ encounter a problem with the AppImage, where you are not able to login. This is a known issue, and is due to the way AppImage works. See [The browser doesn't launch the app after login, how do I log in manually?](#the-browser-doesnt-launch-the-app-after-login-how-do-i-log-in-manually) in the FAQ for how to complete the login manually.
117156
118157
> [!NOTE]
119158
> Unlike the packaged builds, an AppImage is a standalone file that is not integrated into your desktop environment. For the app to show an icon and to handle deep links (such as `deezer://` login callbacks), you either need to use a launcher (like [Gear Lever](https://github.com/mijorus/gear-lever) or [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher)), or need to create and register a desktop entry manually:
@@ -130,9 +169,6 @@ Artifacts will be generated in `artifacts/x64`.
130169
>
131170
> or simply by reloading your user session (log out and back in). The app should now display its icon and correctly open `deezer://` deep links.
132171
133-
> [!Caution]
134-
> If you want to open an issue about this, please do not share your own `deezer://autolog/...` link, as it would allow anyone to log into your account without your consent.
135-
136172
### rpm / deb / tar.xz
137173
138174
To generate the `rpm`/`deb`/`tar.xz` packages, you can use:
@@ -202,7 +238,7 @@ To run it, you can use:
202238
flatpak run dev.aunetx.deezer
203239
```
204240

205-
## Development
241+
## Contributing
206242

207243
If you want to contribute to this project, please read the [contribution guidelines](CONTRIBUTING.md) file.
208244

@@ -243,6 +279,35 @@ DZ_DEVTOOLS=yes ./deezer-desktop # or any other way to launch the app
243279

244280
Once the old data is cleared, kill the app completely (make sure it is not running in the background) and relaunch it. You should now be able to log in successfully.
245281

282+
### The browser doesn't launch the app after login, how do I log in manually?
283+
284+
When you log in, the browser is supposed to open a `deezer://autolog/<id>` callback URL that hands the session over to the app. If your browser fails to launch the app automatically (for example, the `deezer://` handler is not registered, which is common with AppImages), you can trigger the callback manually.
285+
286+
1. Complete the login flow in your browser. Copy the callback URL by right-clicking on the "Open Deezer" button and copying the link address. It should look like this:
287+
288+
```
289+
deezer://autolog/<id>
290+
```
291+
292+
2. Open that URL manually in your terminal. You can use `xdg-open`, `gio open` or pass it directly to the app executable. For example:
293+
294+
```
295+
xdg-open deezer://www.deezer.com/autolog/<id>
296+
```
297+
298+
If the plain `deezer://autolog/<id>` form does not work, use the full web URL variant instead: `deezer://www.deezer.com/autolog/<id>`.
299+
300+
This is especially common with the AppImage, since it is not integrated into your desktop environment and the `deezer://` handler is often not registered. In that case, you can pass the URL directly to the AppImage from its directory:
301+
302+
```sh
303+
deezer-desktop-*.AppImage deezer://www.deezer.com/autolog/<id>
304+
```
305+
306+
For more information, see [issue #29](https://github.com/aunetx/deezer-linux/issues/29).
307+
308+
> [!Caution]
309+
> Never share your `deezer://autolog/...` link with anyone, as it would allow them to log into your account without your consent. If you open an issue about this, make sure to remove your link first.
310+
246311
### How can I use my IME/virtual keyboard on Deezer under Wayland?
247312

248313
_IME: Input Method Editor. Usually used for languages like Chinese, Japanese, Korean, etc._

0 commit comments

Comments
 (0)