Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new docs and work one some Issues #17

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/new-type.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: New List Format Request
description: Request a new file format for you adblocker
title: "New file format request - <ADBLOCKER>"
labels: ["Enhancement", "Blocklists"]
body:
- type: markdown
attributes:
value: |
Thank you for creating this issue, please tell us more.
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: Example -> email@example.com
validations:
required: false
- type: input
id: adblocker
attributes:
label: What is the name of your adblocker?
description: Please, enter the name of tyour adblocker
placeholder: Example -> Pi-Hole
validations:
required: true
- type: input
id:
attributes:
label: What is the name of your adblocker?
description: Please, enter the name of tyour adblocker
placeholder: Example -> Pi-Hole
validations:
required: true
- type: input
id:
attributes:
label: Please, provide the URL to the adblocker official web
description: Please, enter the URL of the official web page of the adblocker
placeholder: Example -> pi-hole.net
validations:
required: true
- type: input
id:
attributes:
label: Please, provide the URL to the adblocker documentation
description: Please, enter the URL of the official adblocker documentation
placeholder: Example -> docs.pi-hole.net
validations:
required: true
- type: textarea
id: format_example
attributes:
label: Format Example
description: If you have a example list of the adblocker format, you can put it here.
render: shell
- type: textarea
id: extra-info
attributes:
label: Extra Info about the request
description: Tell us extra info about the request
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Isaaker/Ghost_Simulator_ES/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- label: I read the avaible Documentation
required: true
- label: I have checked that there is no issue on the same subject
required: true
- label: I have checked that my issue does not contain any relevant security data (Passwords, Secrets or Users)
required: true
- label: I have checked that my issue is not a Security Vulneability. Please, read Security Policy.
required: true
15 changes: 15 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/requirements.txt" # Location of package manifests
schedule:
interval: "weekly"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
65 changes: 65 additions & 0 deletions .github/workflows/deploy_gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: MkDocs Deploy

on:
workflow_dispatch:
push:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'

jobs:
linters:
name: Repository linters
runs-on: ubuntu-latest
steps:
- name: Check out the code
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # @v4.1.7
- name: Install NodeJs # Install Software NodeJs
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # @v4.0.2
with:
node-version: 16
- name: Install repo-linter
run: |
npm install -g repolinter
- name: Run Repo Linter
run: |
repolinter --rulesetFile cfg/repolint.json lint .

scan:
name: gitleaks
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
with:
fetch-depth: 0
- uses: gitleaks/gitleaks-action@44c470ffc35caa8b1eb3e8012ca53c2f9bea4eb5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITLEAKS_CONFIG: cfg/gitleaks.toml

build:
name: MkDocs Github Pages automatic deployment
runs-on: ubuntu-latest
needs:
- linters
- scan
steps:
- name: Checkout main
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332

- name: Set up Python 3.9
uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
with:
python-version: '3.9'

- name: Install requirements
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt

- name: MkDocs gh-deploy
run: |
git pull
mkdocs gh-deploy -v
31 changes: 31 additions & 0 deletions .github/workflows/repolint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Action to Lint open repositories for common issues
# Uses https://github.com/todogroup/repolinter

# Needs master/repolint.json

name: Repository Linter
on:
workflow_dispatch:

jobs:
launch-repolint:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }} # Only 1 instance at time
runs-on: ubuntu-latest

steps:
- name: Check out the code
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # @v4.1.7

- name: Install NodeJs # Install Software NodeJs
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # @v4.0.2
with:
node-version: 16

- name: Install repo-linter
run: |
npm install -g repolinter

- name: Run Repo Linter
run: |
repolinter --rulesetFile cfg/repolint.json lint .
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Empty
22 changes: 21 additions & 1 deletion Lists/BLACKLIST.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1534,4 +1534,24 @@ gew1-spclient.spotify.com
canvaz.scdn.com
canvaz.scdn.co
analytics.spotify.net
labs.spotify.com
labs.spotify.com
ap-guc3.spotify.com
ap-gew1.spotify.com
atc.spotify.map.fastly.net
ap-gew4.spotify.com
atc.spotify.map.fastly.net
e10499.dsce9.akamaiedge.net
region1.app-measurement.com
d1tcwf12y4kqv3.cloudfront.net
tpc.googlesyndication.com
a297.dscc.akamai.net
securepubads.g.doubleclick.net
aet.spotify.com
pubads.g.doubleclick.net
get-bx.g.aaplimg.com
mobile.events.data.microsoft.com
a1556.dsct.akamai.net
a1051.dscw154.akamai.net
video-akpcw-cdn-spotify-com.akamaized.net
2qbjhhcl4u87btjbo7dh8vi2n.litix.io
litix.io
6 changes: 5 additions & 1 deletion Lists/WHITELIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,14 @@ License: https://github.com/Isaaker/Spotify-AdsList/blob/main/LICENSE.txt
| spclient.wg.spotify.com | Spotify domain providing music and controlling it | The player does not work, it is impossible to control the audio playback and this causes it to skip songs continuously and without stopping |
| open.spotify.com | In principle, I have not observed any adverse effect on the applications when blocking this domain, however, blocking it makes it impossible to access the spotify web platform | Unable to access the spotify web player |
| api-partner.spotify.com | This domain is the one that provides some of the main images of the app such as the home screen, the application will continue to play music but some screens may not work properly or may be inaccessible by displaying an error. | Problems displaying images |
| partners.wg.spotify.com | This domain is the one that provides some of the main images of the app such as the home screen, the application will continue to play music but some screens may not work properly or may be inaccessible by displaying an error. | Problems displaying images |
| api.spotify.com | Spotify main API |

## Plain List

- login5.spotify.com
- spclient.wg.spotify.com
- open.spotify.com
- api-partner.spotify.com
- api-partner.spotify.com
- partners.wg.spotify.com
- api.spotify.com
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
|Name|Type|Status|
|--|--|--|
|Build Blocklist|Build|[![Build Blocklist](https://github.com/Isaaker/Spotify-AdsList/actions/workflows/build_blocklist.yml/badge.svg)](https://github.com/Isaaker/Spotify-AdsList/actions/workflows/build_blocklist.yml)|
|Deploy Mkdocs|Deploy|[![Deploy Mkdocs](https://github.com/Isaaker/Spotify-AdsList/actions/workflows/deploy_gh-pages.yml/badge.svg)](https://github.com/Isaaker/Spotify-AdsList/actions/workflows/deploy_gh-pages.yml)
|SAST GitLeaks|Security|[![SAST GitLeaks](https://github.com/Isaaker/piscinadeentropia/actions/workflows/sast-gitleaks.yml/badge.svg)](https://github.com/Isaaker/piscinadeentropia/actions/workflows/sast-gitleaks.yml)|
|SAST Semgrep|Security|[![SAST Semgrep](https://github.com/Isaaker/Ghost_Simulator_ES/actions/workflows/semgrep.yml/badge.svg)](https://github.com/Isaaker/Ghost_Simulator_ES/actions/workflows/semgrep.yml)|

Expand All @@ -27,7 +28,11 @@ I also recommend you to complement the list with some standard lists of ad domai
- https://github.com/topics/adblock
- https://github.com/topics/adblock-list

**[Learn more about Spotify Ads List](https://github.com/Isaaker/Spotify-AdsList/wiki)**
**[Learn more about Spotify Ads List](https://spotify.piscinadeentropia.es)**

## Installation

**To install, please [read our installation tutorial](https://spotify.piscinadeentropia.es/installation)**

## List Versions

Expand All @@ -40,7 +45,9 @@ The list is highly compatible, so here are the different versions so that you ca
| Standard | Highly compatible, no particular system | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/standard_list.txt | https://github.com/Isaaker/Spotify-AdsList/blob/main/Lists/standard_list.txt
| Pi-hole | Compatible with pi-hole and other systems that do not require anything other than domains | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/pi-hole.txt | https://github.com/Isaaker/Spotify-AdsList/blob/main/Lists/pi-hole.txt
| Dnsmasq | Compatible with dnsmasq | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/dnsmasq.txt | https://github.com/Isaaker/Spotify-AdsList/blob/main/Lists/dnsmasq.txt
| Adguard | Compatible with adguard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt | https://github.com/Isaaker/Spotify-AdsList/blob/main/Lists/adguard.txt
| Adguard | Compatible with adguard & uBlock Origin | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt | https://github.com/Isaaker/Spotify-AdsList/blob/main/Lists/adguard.txt

**To suscribe with uBlock Origin read the installation documentation -> [Add to uBlock](spotify.piscinadeentropia.es/installation)**

## Whitelist

Expand All @@ -58,8 +65,8 @@ Here you can find all the tests made, their date and more details.
| Web App | Mac | MacOS (14.2.1) | Firefox (122.0) | 27/1/24 | ![Static Badge](https://img.shields.io/badge/Status-OK-green?logo=spotify) | pihole | @isaaker |
| Web App | Virtual Machine| Debian 12 | Firefox ESR (115.3.0esr)| 27/1/24 | ![Static Badge](https://img.shields.io/badge/Status-ERROR-red?logo=spotify) | pihole | @isaaker |
| Web App | Virtual Machine | Debian 12 | Chromium (121.0.6167.85)| 27/1/24 | ![Static Badge](https://img.shields.io/badge/Status-ERROR-red?logo=spotify) | pihole | @isaaker |
| App | Mac | MacOS (14.5) | - | 16/6/24 | ![Static Badge](https://img.shields.io/badge/Status-OK-green?logo=spotify) | pihole | @isaaker |
| App | iPhone | iOS (17.3.1) | - | 15/2/24 | ![Static Badge](https://img.shields.io/badge/Status-OK-green?logo=spotify) | pihole | @isaaker |
| App | Mac | MacOS (14.5) | - | 4/7/24 | ![Static Badge](https://img.shields.io/badge/Status-OK-green?logo=spotify) | pihole | @isaaker |
| App | iPhone | iOS (17.5.1) | - | 4/7/24 | ![Static Badge](https://img.shields.io/badge/Status-OK-green?logo=spotify) | pihole | @isaaker |
| App | Google Pixel 4a | Android 13 | - | 20/4/24 | ![Static Badge](https://img.shields.io/badge/Status-OK-green?logo=spotify) | adguard | @mfjt |
| App | Linux Laptop | Fedora Workstation 40 | - | 22/4/24 | ![Static Badge](https://img.shields.io/badge/Status-OK-green?logo=spotify) | adguard | @SudoVanilla |
| App | Mac | MacOS (14.5) | - | 23/6/24 | ![Static Badge](https://img.shields.io/badge/Status-Unknow-yellow?logo=spotify) | adguard | @y2kviv |
Expand All @@ -70,10 +77,10 @@ Here you can find all the tests made, their date and more details.
**If you have tested the list, please create a issue with type "Testing" to add more tested devices. [Add new tested device](https://github.com/Isaaker/Spotify-AdsList/issues/new?assignees=&labels=Testing&projects=&template=testing.yml&title=New+Testing+Device%3A+%5BDevice+Name%5D+%2F+%5BDevice+OS%26Version%5D)**

## License
The code is under **Creative Commons Attribution-ShareAlike 4.0 International Public License**, view the license at: https://github.com/Isaaker/Spotify-AdsList/blob/main/LICENSE.txt
The code is under **Creative Commons Attribution-ShareAlike 4.0 International Public License**, view the [license here](https://spotify.piscinadeentropia.es/license)

![Creative Commons Attribution-ShareAlike 4.0 International Public License Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/images/License-Image.jpeg)

# Contributing
## Contributing

To learn more about how to contribute to this repository, I recommend you read [CONTRIBUTING.md](https://github.com/Isaaker/Spotify-AdsList/blob/main/CONTRIBUTING.md)
To learn more about how to contribute to this repository, I recommend you read [CONTRIBUTING.md](https://spotify.piscinadeentropia.es/contributing)
6 changes: 6 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Support

You can get support using this methods:

- [Documentation](https://spotify.piscinadeentropia.es)
- [Issues](https://github.com/Isaaker/Spotify-AdsList/issues/new/choose)
Loading
Loading