AdGuard for Safari app extension
The most advanced ad blocking extension for Safari
Free and open source, highly customizable and lightning fast ad blocking extension.
AdGuard.com |
Reddit |
Twitter |
Telegram
AdGuard for Safari
Ad blocking extensions for Safari are having hard time since Apple started to force everyone to use the new SDK. AdGuard extension is supposed to bring back the high quality ad blocking back to Safari.
Unlike other major ad blockers, AdGuard provides some extra features you are used to have with the traditional (now deprecated) extensions:
AdGuard for Safari is based on the Safari native content blocking API, which makes it lightning fast, but somewhat limited in capabilities. For instance, Safari limits the number of rules a content blocker can have.
Better yet, there is a full-fledged AdGuard for Mac
With all above said, there is a solution that is even more effective than AG Safari extension. I mean, of course, AdGuard for Mac. It can:
You can try it out for free.
How to build AdGuard for Safari
AdGuard for Safari consists of three parts:
Prerequisites
Also, you need to install these packages globally:
yarn global add electron-packager
yarn global add node-gyp
yarn global add electron-osx-sign
How to build
To run application in development mode
cd ElectronMainApp
Install local dependencies by running:
yarn install
How to debug the app
Debug window
Launch the application via:
yarn start
Open menu View -> Toggle Developer Tools
Debug main process
Launch the application via
yarn inspect
Open URI chrome://inspect
in Chromium
Then add a network target localhost:5858
via button "Configure" and select this target below.
Build and run in production mode
Replace the following line in file ./AdGuard/Config.xcconfig
AG_SIGN = <YOUR APPLE DEVELOPER COMMON NAME>
where <YOUR APPLE DEVELOPER COMMON NAME>
is your codesign identity
Make sure your system Nodejs version higher v8.9.4.
Steps to check it:
if you use nvm
run
nvm use system
node -v
otherwise
node -v
Open AdGuard.xcworkspace
in Xcode and run building project
How to run tests
cd ElectronMainApp
yarn test
Preparing and building Adguard.
Environment requirements
Xcode command line tools
xcode-select --install
ruby
module bundler
if it is not in the systemsudo gem install bundler
fastlane match
. The file ./fastlane/env.default
contains variables (SENSITIVE_VARS_PATH
, APP_STORE_CONNECT_API_KEY_PATH
) that define the paths to files with private information necessary for fastlane match
to work. Create these files in a hidden location with the appropriate contents and specify their paths in the these variables.configure.sh dev
script, which will install the necessary components and certificates locally.cd <repository> ./configure.sh dev
Check certificates names in Scripts/ExportOptions.plist
Building SafariConverterLib dependency
For converting rules to content-blocker format we use an external library as a binary built from https://github.com/AdguardTeam/SafariConverterLib/
, that ConverterTool
binary should be placed in ./libs/
.
You use ./Scripts/download-lib.sh
to download the latest release version of that binary from Github.
Common issues
Use fixed electron-osx-sign
npm install -g electron-userland/electron-osx-sign#timestamp-server
How to release standalone builds
package.json
and AdGuard/standalone.xcconfig
or AdGuard/standalone-beta.xcconfig
updates/updates.json
and release.json
in gh-pages branchBuild application
./build.sh <channel> [--notarize=0]
Arguments:
<channel>
-- updates channel:
mas
-- Mac App Storebeta
-- standalone betarelease
-- standalone release[--notarize=0]
-- optional parameter to skip notarizationOutput directory build
contains:
Adguard for Safari.app
-- signed and notarized app.Adguard for Safari.app.zip
-- zip of signed and notarized app.Adguard for Safari.xcarchive
-- app archive.Adguard for Safari.xcarchive.zip
-- zip of app archiveversion.txt
-- version info (CI requirement).updates.json
-- json file with updates info.release.json
-- json file with updates info.Clean install
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.