maza-ad-blocking/README.md

122 lines
2.3 KiB
Markdown
Raw Normal View History

2020-01-03 17:35:23 +01:00
# Maza ad blocking
2020-01-03 17:21:55 +01:00
Simple and efficient local ad blocking throughout the network.
2020-01-03 18:03:22 +01:00
<img alt="maza logo" src="media/maza.png" width="500">
2020-01-03 18:31:45 +01:00
- You don't have to install any browser extensions or applications, you just use the tools of your operating system.
- You update the list of DNS to be blocked with a single stroke.
- Opensource.
- Just bash.
2020-01-03 17:37:07 +01:00
## 🏃Run
2020-01-03 17:29:15 +01:00
2020-01-03 17:37:07 +01:00
### 📡 Update database
2020-01-03 17:29:15 +01:00
``` bash
maza update
```
2020-01-03 17:37:07 +01:00
### 🔨 Start
2020-01-03 17:29:15 +01:00
``` bash
sudo maza start
```
2020-01-03 17:37:07 +01:00
### 🛠 Stop
2020-01-03 17:29:15 +01:00
``` bash
2020-01-06 13:18:36 +01:00
maza stop
2020-01-03 17:29:15 +01:00
```
2020-01-03 17:37:07 +01:00
### ⚖️ Status
2020-01-03 17:29:15 +01:00
``` bash
maza status
```
2020-01-03 17:37:07 +01:00
## ⚙️ Install
2020-01-03 17:29:15 +01:00
2020-01-03 17:37:07 +01:00
### 👀 Requirements
2020-01-03 17:29:15 +01:00
- bash 4.0 or higher
- curl
Then you do this.
``` bash
curl -o maza https://raw.githubusercontent.com/tanrax/maza-ad-blocking/master/maza
chmod +x maza
sudo mv maza /usr/local/bin
```
2020-01-04 08:53:35 +01:00
## DNSMASQ
Unfortunately the hosts file does not support sub-domains (wildcards), which is necessary to correctly filter all DNS. You will need to install locally a server for that purpose, Maza supports the Dnsmasq format. Here's an example for OSX.
### 1 Install
```bash
brew install dnsmasq
```
### 2 Configure
Edit the file.
```
/usr/local/etc/dnsmasq.conf
```
Add the following lines.
```
conf-file=(your user path)/.maza/dnsmasq.conf
```
Start DNSMASQ.
```bash
sudo brew services stop dnsmasq
sudo brew services start dnsmasq
```
### 3 Tell your OS to use your DNS server
Delete the list of OSX DNS servers and add the 3 addresses. The first one will be your local server, and the other 2 belong to OpenDNS, which you can use any other.
```bash
127.0.0.1
208.67.222.222
208.67.220.220
```
Refresh your DNS cache
```bash
sudo dscacheutil -flushcache; sudo killall -HUP mDNSResponder
```
2020-01-05 08:45:25 +01:00
### Extra: dnsmasq is in charge of solving all DNS
2020-01-05 08:57:06 +01:00
Add in confiigure file: `/usr/local/etc/dnsmasq.conf`
2020-01-05 08:45:25 +01:00
```
no-resolv
server=208.67.222.222
server=208.67.220.220
```
### Extra: dnsmasq have test domains
2020-01-05 08:57:06 +01:00
If you want all your `.localhost` domains, for example, point to localhost add in confiigure file: `/usr/local/etc/dnsmasq.conf`
2020-01-05 08:45:25 +01:00
```
address=/.localhost/127.0.0.1
```
2020-01-03 17:37:07 +01:00
## ⚠️ CAUTION
2020-01-03 17:21:55 +01:00
- Only compatible with Linux and OSX operating systems.
- Remember to make a backup copy of `/etc/hosts` in case of unforeseen circumstances, neither the project nor its author will be responsible for any possible repercussions derived from not carrying out this action.