diff --git a/.github/README.md b/.github/README.md
index a779842ed..60a7b8a9d 100644
--- a/.github/README.md
+++ b/.github/README.md
@@ -1,7 +1,7 @@
-
+
-
+
FilterLists is the independent, comprehensive directory of filter and host lists for advertisements, trackers, malware, and annoyances.
@@ -25,28 +25,28 @@ FilterLists helps to protect your privacy and security when using the internet.
Using a software firewall or adblocker has become a key tool in protecting one's privacy online. While the current business model of the "free" internet relies upon advertising revenue, publishers have become too flippant about tracking users without their consent. Advertising networks track users' browsing habits around the internet building lucrative profiles to exploit for targeted marketing or big data research. Until internet publishers develop more transparency or a new business model, we must continue to take the protection of our privacy into our hands.
-Typical adblockers run as an extension in popular web browsers. As we browse the internet, they compare HTTP requests to their list of hosts and filters to selectively block advertisements, trackers, and malware. This filtering helps to protect the surfer's privacy, prevents [malvertising attacks](http://www.wired.com/insights/2014/11/malvertising-is-cybercriminals-latest-sweet-spot/ "Why Malvertising Is Cybercriminals' Latest Sweet Spot - Wired"), and [reduces bandwidth requirements](http://venturebeat.com/2015/07/08/blocking-ads-can-cut-network-traffic-25-to-40-study-shows/ "Blocking Ads Can Cut Network Traffic 25% to 40%, Study Shows - VentureBeat"). Thousands of contributors work hard to maintain these FilterLists for anyone to use. Locating and selecting these lists, however, has not historically been very easy. This project was launched in 2015 to solve that problem.
+Typical adblockers run as an extension in popular web browsers. As we browse the internet, they compare HTTP requests to their list of hosts and filters to selectively block advertisements, trackers, and malware. This filtering helps to protect the surfer's privacy, prevents [malvertising attacks](http://www.wired.com/insights/2014/11/malvertising-is-cybercriminals-latest-sweet-spot/ "Why Malvertising Is Cybercriminals' Latest Sweet Spot - Wired"), and [reduces bandwidth requirements](http://venturebeat.com/2015/07/08/blocking-ads-can-cut-network-traffic-25-to-40-study-shows/ 'Blocking Ads Can Cut Network Traffic 25% to 40%, Study Shows - VentureBeat'). Thousands of contributors work hard to maintain these FilterLists for anyone to use. Locating and selecting these lists, however, has not historically been very easy. This project was launched in 2015 to solve that problem.
# Services
-| Service | Description | More |
-|---|---|---|
-| Website | A React & TypeScript UI built with Ant Design. | [](https://filterlists.com/) [](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=18) [](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=4) [](https://github.com/users/collinbarrett/packages/container/package/filterlists-web) [](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com) |
-| Directory API | An ASP.NET Core API serving the core FilterList information. | [](https://filterlists.com/api/?urls.primaryName=Directory) [](https://filterlists.com/api/directory/v1/swagger.json) [](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=27) [](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=3) [](https://github.com/users/collinbarrett/packages/container/package/filterlists-directory-api) [](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com%2Fapi%2Fdirectory%2Fv1%2Fswagger.json) |
-| Archival API | An ASP.NET Core API archiving and serving copies of FilterLists for mirrors and analysis. | [](https://filterlists.com/api/?urls.primaryName=Archival) [](https://filterlists.com/api/archival/v1/swagger.json) [](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=29) [](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=7) [](https://github.com/users/collinbarrett/packages/container/package/filterlists-archival-api) [](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com%2Fapi%2Farchival%2Fv1%2Fswagger.json) |
-| Reverse Proxy | An NGINX instance forwarding requests to the respective services above. | [](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=21) [](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=5) [](https://observatory.mozilla.org/analyze/filterlists.com) [](https://hstspreload.org/?domain=filterlists.com) |
+| Service | Description | More |
+| ------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Website | A React & TypeScript UI built with Ant Design. | [](https://filterlists.com/) [](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=18) [](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=4) [](https://github.com/users/collinbarrett/packages/container/package/filterlists-web) [](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com) |
+| Directory API | An ASP.NET Core API serving the core FilterList information. | [](https://filterlists.com/api/?urls.primaryName=Directory) [](https://filterlists.com/api/directory/v1/swagger.json) [](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=27) [](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=3) [](https://github.com/users/collinbarrett/packages/container/package/filterlists-directory-api) [](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com%2Fapi%2Fdirectory%2Fv1%2Fswagger.json) |
+| Archival API | An ASP.NET Core API archiving and serving copies of FilterLists for mirrors and analysis. | [](https://filterlists.com/api/?urls.primaryName=Archival) [](https://filterlists.com/api/archival/v1/swagger.json) [](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=29) [](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=7) [](https://github.com/users/collinbarrett/packages/container/package/filterlists-archival-api) [](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com%2Fapi%2Farchival%2Fv1%2Fswagger.json) |
+| Reverse Proxy | An NGINX instance forwarding requests to the respective services above. | [](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=21) [](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=5) [](https://observatory.mozilla.org/analyze/filterlists.com) [](https://hstspreload.org/?domain=filterlists.com) |
# Contributing
## Adding or Updating Lists
-To submit a new list or update data about an existing list, please submit a pull request to [data](https://github.com/collinbarrett/FilterLists/tree/master/services/Directory/data) in conjunction with the data model described [here](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar). Once you open the pull request, our [Migrate bot](https://github.com/collinbarrett/FilterLists/blob/master/services/Directory/azure-pipelines.migrate.yaml) will create an [Entity Framework Core migration](https://docs.microsoft.com/en-us/ef/core/managing-schemas/migrations/?tabs=dotnet-core-cli) with your changes and test them. Please ensure to [grant the bot permissions to push to your pull request branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork). You can find more details on this process [here](https://github.com/collinbarrett/FilterLists/issues/1674).
+To submit a new list or update data about an existing list, please submit a pull request to [data](https://github.com/collinbarrett/FilterLists/tree/main/services/Directory/data) in conjunction with the data model described [here](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar). Once you open the pull request, our [Migrate bot](https://github.com/collinbarrett/FilterLists/blob/main/services/Directory/azure-pipelines.migrate.yaml) will create an [Entity Framework Core migration](https://docs.microsoft.com/en-us/ef/core/managing-schemas/migrations/?tabs=dotnet-core-cli) with your changes and test them. Please ensure to [grant the bot permissions to push to your pull request branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork). You can find more details on this process [here](https://github.com/collinbarrett/FilterLists/issues/1674).
Alternatively, you can [open a new issue](https://github.com/collinbarrett/FilterLists/issues/new) providing information for all of the fields described in the [data model](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar).
In the future, we hope to have an easier form UI to submit updates. Follow [this issue](https://github.com/collinbarrett/FilterLists/issues/372) for any progress on that feature.
-Note: Since the primary FilterLists.com site does not support Internet Explorer, we also have a separate page for tracking protection lists (TPL) [here](https://github.com/collinbarrett/FilterLists/blob/master/web/public/tpl.html) and viewed [here](https://filterlists.com/tpl.html).
+Note: Since the primary FilterLists.com site does not support Internet Explorer, we also have a separate page for tracking protection lists (TPL) [here](https://github.com/collinbarrett/FilterLists/blob/main/web/public/tpl.html) and viewed [here](https://filterlists.com/tpl.html).
## Adding or Updating Rules
@@ -61,11 +61,11 @@ We have containerized FilterLists to make it as easy as possible for contributer
3. Clone the FilterLists git repository to your computer. [Docs](https://help.github.com/en/articles/cloning-a-repository)
4. Navigate to the root directory of your locally cloned FilterLists git repository in a command-line interface.
5. Start the APIs:
-`docker-compose -f docker-compose/docker-compose.yml -f docker-compose/docker-compose.override.yml up -d`
-You can then view the API docs and execute API calls here: http://localhost:8080/api/
+ `docker-compose -f docker-compose/docker-compose.yml -f docker-compose/docker-compose.override.yml up -d`
+ You can then view the API docs and execute API calls here: http://localhost:8080/api/
6. Start the Web app:
-`npm i --cwd web && npm start --prefix web`
-You can then view the Web app calling your local instance of the Directory API here: http://localhost:3000
+ `npm i --cwd web && npm start --prefix web`
+ You can then view the Web app calling your local instance of the Directory API here: http://localhost:3000
# Acknowledgements
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
index e035f08b8..2fb172c86 100644
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -1,11 +1,11 @@
-name: "CodeQL"
+name: 'CodeQL'
on:
push:
- branches: [master]
+ branches: [main]
pull_request:
# The branches below must be a subset of the branches above
- branches: [master]
+ branches: [main]
schedule:
- cron: '0 23 * * 6'
@@ -25,39 +25,39 @@ jobs:
# https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
steps:
- - name: Checkout repository
- uses: actions/checkout@v2
- with:
- # We must fetch at least the immediate parents so that if this is
- # a pull request then we can checkout the head.
- fetch-depth: 2
+ - name: Checkout repository
+ uses: actions/checkout@v2
+ with:
+ # We must fetch at least the immediate parents so that if this is
+ # a pull request then we can checkout the head.
+ fetch-depth: 2
- # If this run was triggered by a pull request event, then checkout
- # the head of the pull request instead of the merge commit.
- - run: git checkout HEAD^2
- if: ${{ github.event_name == 'pull_request' }}
+ # If this run was triggered by a pull request event, then checkout
+ # the head of the pull request instead of the merge commit.
+ - run: git checkout HEAD^2
+ if: ${{ github.event_name == 'pull_request' }}
- # Initializes the CodeQL tools for scanning.
- - name: Initialize CodeQL
- uses: github/codeql-action/init@v1
- with:
- languages: ${{ matrix.language }}
+ # Initializes the CodeQL tools for scanning.
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v1
+ with:
+ languages: ${{ matrix.language }}
- # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
- # If this step fails, then you should remove it and run the build manually (see below)
- - name: Autobuild
- uses: github/codeql-action/autobuild@v1
+ # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
+ # If this step fails, then you should remove it and run the build manually (see below)
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v1
- # âšī¸ Command-line programs to run using the OS shell.
- # đ https://git.io/JvXDl
+ # âšī¸ Command-line programs to run using the OS shell.
+ # đ https://git.io/JvXDl
- # âī¸ If the Autobuild fails above, remove it and uncomment the following three lines
- # and modify them (or add more) to build your code if your project
- # uses a compiled language
+ # âī¸ If the Autobuild fails above, remove it and uncomment the following three lines
+ # and modify them (or add more) to build your code if your project
+ # uses a compiled language
- #- run: |
- # make bootstrap
- # make release
+ #- run: |
+ # make bootstrap
+ # make release
- - name: Perform CodeQL Analysis
- uses: github/codeql-action/analyze@v1
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v1
diff --git a/reverse-proxy/azure-pipelines.yaml b/reverse-proxy/azure-pipelines.yaml
index ff2501691..d243c9bb9 100644
--- a/reverse-proxy/azure-pipelines.yaml
+++ b/reverse-proxy/azure-pipelines.yaml
@@ -1,7 +1,7 @@
trigger:
batch: false
branches:
- include: [master]
+ include: [main]
paths:
include:
[
@@ -27,7 +27,7 @@ steps:
reverse-proxy/location-includes/*
reverse-proxy/conf.d/*
TargetFolder: $(Build.ArtifactStagingDirectory)
- condition: eq(variables['Build.SourceBranch'], 'refs/heads/master')
+ condition: eq(variables['Build.SourceBranch'], 'refs/heads/main')
- task: CopyFiles@2
displayName: stage docker-compose files
@@ -37,7 +37,7 @@ steps:
docker-compose.yml
docker-compose.prod.yml
TargetFolder: $(Build.ArtifactStagingDirectory)
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
- task: PublishBuildArtifacts@1
displayName: publish files
@@ -45,4 +45,4 @@ steps:
PathtoPublish: $(Build.ArtifactStagingDirectory)
ArtifactName: drop
publishLocation: Container
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
diff --git a/services/Archival/FilterLists.Archival.Api/SwaggerConfigurationExtensions.cs b/services/Archival/FilterLists.Archival.Api/SwaggerConfigurationExtensions.cs
index 0abffcfce..f53df6a91 100644
--- a/services/Archival/FilterLists.Archival.Api/SwaggerConfigurationExtensions.cs
+++ b/services/Archival/FilterLists.Archival.Api/SwaggerConfigurationExtensions.cs
@@ -23,7 +23,7 @@ public static void AddSwaggerGen(this IServiceCollection services)
License = new OpenApiLicense
{
Name = "MIT License",
- Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/master/LICENSE")
+ Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/main/LICENSE")
}
});
diff --git a/services/Archival/azure-pipelines.api.yaml b/services/Archival/azure-pipelines.api.yaml
index 49ff554de..0b5feb79a 100644
--- a/services/Archival/azure-pipelines.api.yaml
+++ b/services/Archival/azure-pipelines.api.yaml
@@ -1,7 +1,7 @@
trigger:
batch: false
branches:
- include: [master]
+ include: [main]
paths:
include:
[
@@ -24,7 +24,7 @@ trigger:
pr:
autoCancel: false
branches:
- include: [master]
+ include: [main]
paths:
include:
[
@@ -76,7 +76,7 @@ steps:
$(Build.BuildId)
env:
DOCKER_BUILDKIT: 1
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
- task: CopyFiles@2
displayName: stage docker-compose files
@@ -86,7 +86,7 @@ steps:
docker-compose.yml
docker-compose.prod.yml
TargetFolder: $(Build.ArtifactStagingDirectory)
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
- task: PublishBuildArtifacts@1
displayName: publish docker-compose files
@@ -94,4 +94,4 @@ steps:
PathtoPublish: $(Build.ArtifactStagingDirectory)
ArtifactName: drop
publishLocation: Container
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
diff --git a/services/Directory/FilterLists.Directory.Api/SwaggerConfigurationExtensions.cs b/services/Directory/FilterLists.Directory.Api/SwaggerConfigurationExtensions.cs
index bec00c75d..73fa64dd2 100644
--- a/services/Directory/FilterLists.Directory.Api/SwaggerConfigurationExtensions.cs
+++ b/services/Directory/FilterLists.Directory.Api/SwaggerConfigurationExtensions.cs
@@ -23,7 +23,7 @@ public static void AddSwaggerGen(this IServiceCollection services)
License = new OpenApiLicense
{
Name = "MIT License",
- Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/master/LICENSE")
+ Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/main/LICENSE")
}
});
diff --git a/services/Directory/azure-pipelines.api.yaml b/services/Directory/azure-pipelines.api.yaml
index 85c58c1b6..22fb88ed4 100644
--- a/services/Directory/azure-pipelines.api.yaml
+++ b/services/Directory/azure-pipelines.api.yaml
@@ -1,7 +1,7 @@
trigger:
batch: false
branches:
- include: [master]
+ include: [main]
paths:
include:
[
@@ -26,7 +26,7 @@ trigger:
pr:
autoCancel: false
branches:
- include: [master]
+ include: [main]
paths:
include:
[
@@ -80,7 +80,7 @@ steps:
$(Build.BuildId)
env:
DOCKER_BUILDKIT: 1
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
- task: CopyFiles@2
displayName: stage docker-compose files
@@ -90,7 +90,7 @@ steps:
docker-compose.yml
docker-compose.prod.yml
TargetFolder: $(Build.ArtifactStagingDirectory)
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
- task: PublishBuildArtifacts@1
displayName: publish docker-compose files
@@ -98,4 +98,4 @@ steps:
PathtoPublish: $(Build.ArtifactStagingDirectory)
ArtifactName: drop
publishLocation: Container
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
diff --git a/services/Directory/azure-pipelines.migrate.yaml b/services/Directory/azure-pipelines.migrate.yaml
index c703a1e1e..5608cdc7e 100644
--- a/services/Directory/azure-pipelines.migrate.yaml
+++ b/services/Directory/azure-pipelines.migrate.yaml
@@ -5,7 +5,7 @@ trigger: none
pr:
autoCancel: true
branches:
- include: [master]
+ include: [main]
paths:
include: [services/Directory/data/*]
@@ -110,7 +110,7 @@ steps:
script: |
git remote add upstream https://github.com/collinbarrett/FilterLists.git
git fetch upstream
- git merge upstream/master
+ git merge upstream/main
CONFLICTS=$(git ls-files -u | wc -l)
if [ "$CONFLICTS" -gt 0 ] ; then
echo "Conflicts with upstream repository. Aborting..."
diff --git a/services/azure-pipelines.api-docs.yaml b/services/azure-pipelines.api-docs.yaml
index 74cd35cf4..4d61c6dfc 100644
--- a/services/azure-pipelines.api-docs.yaml
+++ b/services/azure-pipelines.api-docs.yaml
@@ -1,7 +1,7 @@
trigger:
batch: false
branches:
- include: [master]
+ include: [main]
paths:
include: [docker-compose/docker-compose.yml]
@@ -22,7 +22,7 @@ steps:
docker-compose.yml
docker-compose.prod.yml
TargetFolder: $(Build.ArtifactStagingDirectory)
- condition: eq(variables['Build.SourceBranch'], 'refs/heads/master')
+ condition: eq(variables['Build.SourceBranch'], 'refs/heads/main')
- task: PublishBuildArtifacts@1
displayName: publish docker-compose files
@@ -30,4 +30,4 @@ steps:
PathtoPublish: $(Build.ArtifactStagingDirectory)
ArtifactName: drop
publishLocation: Container
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
diff --git a/web/azure-pipelines.yaml b/web/azure-pipelines.yaml
index eed420f34..fbc78f85b 100644
--- a/web/azure-pipelines.yaml
+++ b/web/azure-pipelines.yaml
@@ -1,7 +1,7 @@
trigger:
batch: false
branches:
- include: [master]
+ include: [main]
paths:
include:
[
@@ -13,7 +13,7 @@ trigger:
pr:
autoCancel: false
branches:
- include: [master]
+ include: [main]
paths:
include:
[
@@ -54,7 +54,7 @@ steps:
$(Build.BuildId)
env:
DOCKER_BUILDKIT: 1
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
- task: CopyFiles@2
displayName: stage docker-compose files
@@ -64,7 +64,7 @@ steps:
docker-compose.yml
docker-compose.prod.yml
TargetFolder: $(Build.ArtifactStagingDirectory)
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
- task: PublishBuildArtifacts@1
displayName: publish docker-compose files
@@ -72,4 +72,4 @@ steps:
PathtoPublish: $(Build.ArtifactStagingDirectory)
ArtifactName: drop
publishLocation: Container
- condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
+ condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))