earnestma
/
spotify-adblock
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Add instructions for the Spotify Flatpak package

earne/nixos
abba23 2021-05-04 17:45:48 +02:00
parent 1348407ec7
commit fd92a1c696
1 changed files with 63 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -2,7 +2,9 @@
Spotify adblocker for Linux (macOS untested) that works by wrapping `getaddrinfo` and `cef_urlrequest_create`. It blocks requests to domains that are not on the allowlist, as well as URLs that are on the denylist.
### Notes
* This does not work with the snap and Flatpak Spotify packages.
* This **does not** work with the snap Spotify package.
* This **might not** work with the Flatpak Spotify package, depending on your system's shared libraries' versions.
* The Debian Spotify package can be installed on Debian-based distributions (e.g. Ubuntu) by following the instructions at the bottom of [this page](https://www.spotify.com/us/download/linux/). *(recommended)*
## Build
Prerequisites:
@ -10,26 +12,44 @@ Prerequisites:
* Make
* Rust
---
```bash
$ git clone https://github.com/abba23/spotify-adblock.git
$ cd spotify-adblock
$ make
```
## Install
#### Debian Package
```bash
$ sudo make install
```
#### Flatpak
```bash
$ mkdir -p ~/.spotify-adblock && cp target/release/libspotifyadblock.so ~/.spotify-adblock/spotify-adblock.so
$ mkdir -p ~/.config/spotify-adblock && cp config.toml ~/.config/spotify-adblock
$ flatpak override --user --filesystem="~/.spotify-adblock/spotify-adblock.so" --filesystem="~/.config/spotify-adblock/config.toml" com.spotify.Client
```
## Usage
### Command-line
#### Debian Package
```bash
$ LD_PRELOAD=/usr/local/lib/spotify-adblock.so spotify
```
#### Flatpak
```bash
$ flatpak run --command=sh com.spotify.Client -c 'eval "$(sed s#LD_PRELOAD=#LD_PRELOAD=$HOME/.spotify-adblock/spotify-adblock.so:#g /app/bin/spotify)"'
```
### Desktop file
You can integrate it with your desktop environment by creating a `.desktop` file (e.g. `spotify-adblock.desktop`) in `~/.local/share/applications`. This lets you easily run it from an application launcher without opening a terminal.
Examples:
<details>
<summary>Example</summary>
<summary>Debian Package</summary>
<p>
```
@ -48,11 +68,39 @@ StartupWMClass=spotify
</p>
</details>
## Uninstall
$ sudo make uninstall
<details>
<summary>Flatpak</summary>
<p>
```
[Desktop Entry]
Type=Application
Name=Spotify (adblock)
GenericName=Music Player
Icon=com.spotify.Client
Exec=flatpak run --file-forwarding --command=sh com.spotify.Client -c 'eval "$(sed s#LD_PRELOAD=#LD_PRELOAD=$HOME/.spotify-adblock/spotify-adblock.so:#g /app/bin/spotify)"' @@u %U @@
Terminal=false
MimeType=x-scheme-handler/spotify;
Categories=Audio;Music;Player;AudioVideo;
StartupWMClass=spotify
```
</p>
</details>
## Uninstall
#### Debian Package
```bash
$ sudo make uninstall
```
#### Flatpak
```bash
$ rm -r ~/.spotify-adblock ~/.config/spotify-adblock
$ flatpak override --user --reset com.spotify.Client
```
## Configuration
The allowlist and denylist can be configured in a config file located at `/etc/spotify-adblock/config.toml`, which can be overriden by (in ascending order of precedence):
* `~/.config/spotify-adblock/config.toml`
The allowlist and denylist can be configured in a config file located at (in ascending order of precedence):
* `/etc/spotify-adblock/config.toml` *(default)*
* `~/.config/spotify-adblock/config.toml` *(default for Flatpak)*
* `config.toml` in the working directory