-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathalpine.txt
193 lines (148 loc) · 7.55 KB
/
alpine.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
###################################################################
# unbound-adblock 0.5 Alpine Linux Installation Instructions
# Copyright 2018-2021 Jordan Geoghegan <[email protected]>
###################################################################
###################################################################
# Table of Contents:
###################################################################
* Unbound Configuration Notes
* Upgrade Instructions (upgrade from 0.4)
* Fresh Install Instructions
* Post Install Notes
###################################################################
# Notes:
###################################################################
1) These are the unbound-adblock instrucktions for Alpine Linux
These instructions are known to work on Alpine 3.9.x
2) If something doesn't work, then the script can be easily tweaked
to make it work. The variables set based on OS declaration can be
very easily modified to accomodate nearly any OS/setup
3) This guide assumes you know how to setup Unbound. If not,
there are plenty of online guides to setting up Unbound.
Alpine Linux Unbound Quick Start:
-- Fetch and install example unbound config:
# apk add unbound
$ wget https://www.geoghegan.ca/pub/unbound-adblock/0.5/unbound.conf.example
# install -m 644 -o root unbound.conf.example /etc/unbound/unbound.conf
-- Configure and enable 'unbound-control':
# unbound-control-setup
-- Modify unbound.conf to suit your needs:
NOTE: You will likely need to use the "unbound-control key" override
# vi /etc/unbound/unbound.conf
-- Enable and Start
# rc-update add unbound
# rc-service unbound start
###################################################################
# Upgrade from unbound-adblock 0.4
###################################################################
A fresh install of unbound-adblock is recommended.
###################################################################
# Fresh Installation Guide
###################################################################
1) Install and configure Unbound as a local recursive DNS server
An example unbound.conf can be found here:
https://www.geoghegan.ca/pub/unbound-adblock/0.5/unbound.conf.example
2) Download script:
$ wget https://geoghegan.ca/pub/unbound-adblock/0.5/unbound-adblock.sh
3) Create a new user (we'll call ours "_adblock"):
The user should be created with a default shell of "nologin", home folder
set to /var/empty/ with no password specified (disables password logins)
# adduser -D -s /sbin/nologin _adblock
4) Install script with appropriate permissions:
# install -m 755 -o root -g bin unbound-adblock.sh /usr/local/bin/unbound-adblock
5) Create required files:
# install -m 644 -o _adblock /dev/null /etc/unbound/adblock.rpz
# install -d -o root -g wheel -m 755 /var/log/unbound-adblock
# install -o _adblock -g wheel -m 640 /dev/null /var/log/unbound-adblock/unbound-adblock.log
# install -o _adblock -g wheel -m 640 /dev/null /var/log/unbound-adblock/unbound-adblock.log.0.gz
6) Install GNU coreutils, 'doas' utility and oksh (OpenBSD ksh):
NOTE: 'doas' and 'oksh' are located in the "edge" repository, which is disabled by default.
The below commands selectively permit the edge repository for the specified packages:
---
# apk add coreutils gzip
# apk add doas --update-cache --repository http://dl-3.alpinelinux.org/alpine/edge/main/ --allow-untrusted
# apk add oksh --update-cache --repository http://dl-3.alpinelinux.org/alpine/edge/testing/ --allow-untrusted
# ln -s /bin/oksh /bin/ksh
6.b) OPTIONAL: Install GNU awk for improved performance:
# apk add gawk
7) Give user '_adblock' strict doas permission for the exact command the
script needs run as superuser. NOTE: Unlike 'sudo', _ALL_ users must be
explicitly granted permission to use doas, even the root user.
$ cat /etc/doas.conf
...
permit root
permit nopass _adblock cmd /usr/sbin/unbound-control args -q status
permit nopass _adblock cmd /usr/sbin/unbound-control args -q flush_zone unbound-adblock
permit nopass _adblock cmd /usr/sbin/unbound-control args -q auth_zone_reload unbound-adblock
# Only needed if using old unbound specific 'local-data' backend with '-o unbound'
permit nopass _adblock cmd /sbin/rc-service args unbound restart
...
8) Add a few lines to your unbound.conf located BEFORE the forwarders section:
...
# Required modules for RPZ
module-config: "respip validator iterator"
rpz:
name: "unbound-adblock"
zonefile: "/etc/unbound/adblock.rpz"
rpz-log: yes
rpz-log-name: "unbound-adblock"
...
9) Run script manually using the '-O alpine' argument:
# doas -u _adblock unbound-adblock -O alpine
unbound(ok)
10) Edit _adblock crontab to run unbound-adblock every night at midnight:
# crontab -u _adblock -e
@daily sleep $(echo $((RANDOM\%7200+1))) unbound-adblock -O alpine
Yay! unbound-adblock is now installed!
With the nightly cron job, the list will be regularly updated with
the latest known bad hosts.
Please read the man page for information on how to configure unbound-adblock.
The manpage can be found here: https://www.geoghegan.ca/pub/unbound-adblock/0.5/man/man.txt
To receive notification of new unbound-adblock releases and updates please send an email
to '[email protected]' with a subject line and body of "subscribe unbound-adblock"
###################################################################
# Post Install Notes:
###################################################################
X) To add custom rules or enable features, or add alternate blocklists,
See the "User Configuration Area" located at the top of the script.
This area serves as a built in config file, so please feel free to
edit it and experiment with all the features available within.
---
Note: Most options can also be configured from the command line
X) Regarding Cron Jobs:
Over the past year I've noticed a number of list host servers
going down at midnight in populated timezones (ie West Coast,
East Coast and Western Europe). To be respectful (and to avoid
overloading list providers servers) we have cron jobs
scheduled to run at a random time within a defined interval.
---
With the new default cron job, unbound-adblock will be run every
night at some point between midnight and 2AM, and thus
distributing the load of thousands of queries from numerous
users over a 2 hour period rather than a matter of seconds.
X) If you would like to update the unbound-adblock blocklists at a more frequent
interval you can use a modified cron job:
---
It is essential that you make use of the crontab randomization feature to
ensure use of unbound-adblock remains respecful of blocklist provider resources.
---
The following example runs unbound-adblock every 3 to 4 hours at a random minute
(this avoids flooding the server with traffic at exactly XX:00)
---
Run unbound-adblock every 3 hours Example:
(you can change '*/3' to '*/4' to run every 4 hours)
# crontab -u _adblock -e
...
0 */3 * * * sleep $(echo $((RANDOM\%3600+1))) ; unbound-adblock -O alpine
...
X) Google mandates the use of their DNS servers in many apps and services
and many devices also use hardcoded Google DNS that cannot be changed.
This is both a privacy and freedom concern. If you can, redirect all
DNS traffic to the machine running Unbound. Example PF ruleset:
(This rule should be run on your router/gateway)
...
table <gooDNS4> {8.8.8.8 8.8.4.4}
table <gooDNS6> {2001:4860:4860::8888 2001:4860:4860::8844}
pass in quick to <gooDNS4> rdr-to $adblock
pass in quick to <gooDNS6> rdr-to $adblock6
...