-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.header
167 lines (117 loc) · 8.42 KB
/
README.header
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
# UBNT edgeos-pixelserv Transparent Pixel Server for IP Blackhole Redirects
[](https://github.com/britannic/pixelserv/blob/master/LICENSE.txt) [](https://github.com/britannic/pixelserv) [](https://godoc.org/github.com/britannic/pixelserv) [](https://travis-ci.org/britannic/pixelserv) [](https://coveralls.io/github/britannic/pixelserv?branch=master) [](https://goreportcard.com/report/github.com/britannic/pixelserv)
[community.ubnt.com](https://community.ubnt.com/t5/EdgeMAX/Self-Installer-to-configure-Ad-Server-and-pixelserv-Blocking/td-p/1337892)
NOTE: THIS IS NOT OFFICIAL UBIQUITI SOFTWARE AND THEREFORE NOT SUPPORTED OR ENDORSED BY Ubiquiti Networks®
## Donations and Sponsorship
Please show your thanks by donating to the project using [Square Cash](https://cash.me/$HelmRockSecurity/ "Securely send and receive cash without fees using Square Cash") or [PayPal](https://www.paypal.me/helmrocksecurity/)
[](https://cash.me/$HelmRockSecurity/5 "Give $5 using Square Cash (free money transfer)")
[](https://cash.me/$HelmRockSecurity/10 "Give $10 using Square Cash (free money transfer)")
[](https://cash.me/$HelmRockSecurity/15 "Give $15 using Square Cash (free money transfer)")
[](https://cash.me/$HelmRockSecurity/20 "Give $20 using Square Cash (free money transfer)")
[](https://cash.me/$HelmRockSecurity/50 "Give $50 using Square Cash (free money transfer)")
[](https://cash.me/$HelmRockSecurity/ "Choose your own donation amount using Square Cash (free money transfer)")
[](https://paypal.me/helmrocksecurity/5 "Give $5 using PayPal (PayPal money transfer)")
[](https://paypal.me/helmrocksecurity/10 "Give $10 using PayPal (PayPal money transfer)")
[](https://paypal.me/helmrocksecurity/15 "Give $15 using PayPal (PayPal money transfer)")
[](https://paypal.me/helmrocksecurity/20 "Give $20 using PayPal (PayPal money transfer)")
[](https://paypal.me/helmrocksecurity/50 "Give $50 using PayPal (PayPal money transfer)")
[](https://paypal.me/helmrocksecurity/ "Choose your own donation amount using PayPal (PayPal money transfer)")
We greatly appreciate any and all donations - Thank you! Funds go to maintaining development servers and networks.
## Copyright
* Copyright © [2022 Helm Rock Consulting](https://www.helmrock.com/ "Visit Helm Rock Consulting at https://www.helmrock.com/")
## Overview
pixelserv is a simple webserver that returns a single transparent pixel or content loaded from a file
## Licenses
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
1. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
## Features
* Prevents HTTP 404 page not found messages if used in conjunction with dnsmasq IP redirects ([edgeos-dnsmasq-blacklist]( https://britannic.github.io/blacklist/) provides dnsmasq redirection and blacklisting functionality)
## Compatibility
* edgeos-pixelserv has been tested on the EdgeRouter **ERLite-3**, **ERPoe-5**, **ER-X**:
- EdgeOS versions **v1.7.0-v2.0.9**
* Note: the debian package will not successfully install on a UniFi Gateway, since there is also a default HTTP port 80 listener configured all interfaces
## **Change Log**
* See [changelog](CHANGELOG.md) for details
## Installation
* edgeos-pixelserv installs itself as a service into /etc/init.d/pixelserv
* The installation will modify the router's configuration settings to move "service gui http-port 80" to "service gui http-port 8180" to prevent conflict with pixelserv on port 80
* [Using apt-get](https://github.com/britannic/pixelserv#apt-get-installation---erlite-3-erpoe-5-er-x--er-x-sfp) - works for all routers
* [Using dpkg](#dpkg-installation---best-for-disk-space-constrained-routers) - best for disk space constrained routers
## apt-get Installation - ERLite-3, ERPoe-5, ER-X & ER-X-SFP
* Add the blacklist debian package repository using the router's CLI shell
```bash
configure
set system package repository blacklist components main
set system package repository blacklist description 'Britannic blacklist debian stretch repository'
set system package repository blacklist distribution stretch
set system package repository blacklist url 'https://raw.githubusercontent.com/britannic/debian-repo/master/blacklist/public/'
commit;save;exit
```
* Add the GPG signing key
```bash
sudo curl -L https://raw.githubusercontent.com/britannic/debian-repo/master/blacklist/public.key | sudo apt-key add -
```
* Update the system repositorities and install edgeos-pixelserv
```bash
sudo apt-get update && sudo apt-get install edgeos-pixelserv
```
## dpkg installation - Best for disk space constrained routers
### EdgeRouter ERLite-3, ERPoe-5 and similar MIPS based Edgerouters
```bash
curl -L -O https://raw.githubusercontent.com/britannic/pixelserv/master/edgeos-pixelserv_1.0.8_mips.deb
sudo dpkg -i edgeos-pixelserv_1.0.8_mips.deb
```
### EdgeRouter ER-X & ER-X-SFP
```bash
curl -L -O https://raw.githubusercontent.com/britannic/pixelserv/master/edgeos-pixelserv_1.0.8_mipsel.deb
sudo dpkg -i edgeos-pixelserv_1.0.8_mipsel.deb
```
## Removal
* Removal will modify the router's configuration settings to move "service gui http-port 8180" back to the default "service gui http-port 80"
### EdgeMAX ERLite-x & EdgeMax ER-X
```bash
sudo apt-get remove edgeos-pixelserv
```
### Usage
* Standalone binary
```bash
/config/scripts/pixelserv -h
Usage: pixelserv [options]
-f <file>
load pixel or other content from <file> source
-h Display help
-ip string
IP address for pixelserv.amd64 to bind to (default "127.0.0.1")
-path string
Set HTTP root path (default "/")
-port string
Port number for pixelserv.amd64 to listen on (default "80")
-version
Show version
```
* pixelserv.sysv service (EdgeOS < v1.10.x)
```bash
service pixelserv {start|stop|status|restart|force-reload|reload}
```
* pixelserv service (EdgeOS > v2.0.1)
```bash
systemctl start pixelserv
```