Ad blocking: Install
Add Ad blocking from Starboard's Catalogue, where it is listed under Network. Starboard shows what it may do and tests it before anything is added. At the end, Ad blocking is active and its card is ready for your dashboard.
Before you begin
- Starboard with plug-in API 1.14 or later. An older Starboard is offered an earlier version: read Updates.
- Your Starboard password. Adding and removing a plug-in ask for it.
- Pi-hole 6 or AdGuard Home running on your home network, with its address and password. For AdGuard Home, its user name too.
What it may do
Starboard lists these before you add it, each with its risk.
| Permission | Risk |
|---|---|
Reach other computers on your home network, and the internet (network:lan) |
Medium |
What it runs:
- main: reaches your home network and the internet, and this computer as
host.docker.internal.
Like every plug-in, it runs read only, as a user that is not root, with no extra rights. Its image is pinned by digest, so what you approved is what runs.
Memory and processor
- main: 48 MB of memory and 0.1 of a processor core at most.
These figures are the most it may use.
Add it
- Go to Settings, then Plug-ins, then Catalogue.
- Under Network, find Ad blocking and select Install….
- A slide-out opens with what it can read, change and reach. Read it all.
- Enter your Starboard password and select Install Ad blocking. To stop, select Cancel: nothing is installed.
- Ad blocking's own tab opens under Settings, then Plug-ins. Select Activate. Its state changes to Active.
Add it by its address
On the Catalogue page, under Add one from elsewhere, paste this into The plug-in's manifest address, then select What it does and carry on from step 3:
https://raw.githubusercontent.com/TheMightyTRex/starboard-plugins/main/dns-blocking/starboard-plugin.json
Or run its installer, install.py in its folder, on any computer with Python, and give your Starboard's address.
Set it up
- Go to Settings, then Plug-ins, then Ad blocking.
- In Which one, choose Pi-hole or AdGuard Home.
- In Its address, enter the address you open it at, such as
http://192.0.2.2. - For AdGuard Home only, enter its User name.
- Enter its Password.
- Select Save.
- Add the Blocked today card to your dashboard. Read Dashboard card.
Within a minute the card shows today's number and the status Protected.
Remove it
- Go to Settings, then Plug-ins, then Ad blocking.
- Under Remove, select Remove Ad blocking.
- Choose where its folder goes: Keep it with Starboard's data (in
data/plugins/.removed) or Move it to the holding folder, listed in System, Clean up, where you can put it back or delete it for good. - Enter your Starboard password and select Remove.
Its containers stop and go, and its API key stops working. Nothing is deleted.
To stop it for a while instead, select Deactivate on its tab: its settings and folder are kept.
Find out more
This page on GitHub, where the help is written.