unifios-utilities/README.md

# udm-utilities
A collection of things to enhance the capabilities of your Unifi Dream Machine or Dream Machine Pro. **All solutions in this repo persist through firmware upgrades!**

**Pull Requests welcome! If you use this functionality to do new cool stuff to your UDM/P please send a PR and share it with the community!**

## General Tools
### on-boot-script
Enables init.d style scripts to run on every boot of your UDM. Includes a wpa-supplicant/eap-proxy example.  
**It enables complete customization of your UDM/P and fills the gap that config.gateway.json left behind.**

### python
If you need python3 on your UDM, generally not recommended, can always use it in unifi-os container

## VPN Servers / Clients

### wireguard-go
Run a Wireguard client/server on your UDM/P.  Utilizes wireguard-go, not linux kernel modules.  The performance will take a hit due to that.

## DNS Providers
### dns-common
Configurations for DNS containers, both IPv4 and IPv6.  Utilizes MacVLAN CNI plugins to completely isolate the network stack.

### run-pihole
Run pihole on your UDM with podman.

### nextdns
Run NextDNS on your UDM with podman. 

### AdguardHome
Run AdguardHome on your UDM with podman.

## Cool projects you can use with this

### multicast-relay 
https://hub.docker.com/r/scyto/multicast-relay 
This is a docker container that implements https://github.com/alsmith/multicast-relay to provide mDNS and SSDP on a unfi dream machine. It will likely work on any multi homed host.

### ntopng
https://github.com/tusc/ntopng-udm
Much better network stats for your UDM/P!  Install this docker container and create an on_boot script to make sure it's always running.
Update README.md 2020-05-31 14:01:08 +00:00			`# udm-utilities`
Clarifying intent of this repository 2020-07-06 05:32:35 +00:00			`A collection of things to enhance the capabilities of your Unifi Dream Machine or Dream Machine Pro. All solutions in this repo persist through firmware upgrades!`

Update README.md 2020-07-06 05:32:55 +00:00			`Pull Requests welcome! If you use this functionality to do new cool stuff to your UDM/P please send a PR and share it with the community!`
Update README.md 2020-05-31 13:56:48 +00:00
Update README.md 2020-07-05 20:54:53 +00:00			`## General Tools`
Update README.md 2020-05-31 13:56:48 +00:00			`### on-boot-script`
Clarifying intent of this repository 2020-07-06 05:32:35 +00:00			`Enables init.d style scripts to run on every boot of your UDM. Includes a wpa-supplicant/eap-proxy example.`
Update README.md 2020-07-06 05:33:20 +00:00			`It enables complete customization of your UDM/P and fills the gap that config.gateway.json left behind.`
Update README.md 2020-05-31 13:56:48 +00:00
Update README.md 2020-07-05 20:54:53 +00:00			`### python`
			`If you need python3 on your UDM, generally not recommended, can always use it in unifi-os container`

Wireguard instructions added, nextdns container updates 2020-07-10 03:28:49 +00:00			`## VPN Servers / Clients`

			`### wireguard-go`
			`Run a Wireguard client/server on your UDM/P. Utilizes wireguard-go, not linux kernel modules. The performance will take a hit due to that.`

Update README.md 2020-07-05 20:54:53 +00:00			`## DNS Providers`
Modularization updates (#12) * Store install-cni-plugins.sh once * Newlines in on-boot-script * Update example on_boot.sh for directory * Update README.md examples * Store 20-dns.conflist once * Add modularized nextdns config w/IPv6 support * Make nextdns script more generic * Use common setup script for each dns service * Add missing newlines * Readme updates and ipv6 support * Readme updates and ipv6 support * Final updates and Ipv6 Co-authored-by: exodious <exodious@users.noreply.github.com> 2020-06-28 13:02:50 +00:00			`### dns-common`
Update README.md 2020-07-05 20:54:53 +00:00			`Configurations for DNS containers, both IPv4 and IPv6. Utilizes MacVLAN CNI plugins to completely isolate the network stack.`
Modularization updates (#12) * Store install-cni-plugins.sh once * Newlines in on-boot-script * Update example on_boot.sh for directory * Update README.md examples * Store 20-dns.conflist once * Add modularized nextdns config w/IPv6 support * Make nextdns script more generic * Use common setup script for each dns service * Add missing newlines * Readme updates and ipv6 support * Readme updates and ipv6 support * Final updates and Ipv6 Co-authored-by: exodious <exodious@users.noreply.github.com> 2020-06-28 13:02:50 +00:00
Update README.md 2020-05-31 13:56:48 +00:00			`### run-pihole`
Update README.md 2020-07-05 20:54:53 +00:00			`Run pihole on your UDM with podman.`
Next DNS 2020-06-05 03:50:14 +00:00
Final NextDNS changes 2020-06-05 04:53:50 +00:00			`### nextdns`
Update README.md 2020-07-05 20:54:53 +00:00			`Run NextDNS on your UDM with podman.`
Final NextDNS changes 2020-06-05 04:53:50 +00:00
Added "AdguardHome" (#7) * Update README.md Added AdguardHome * AdguardHome Added AdguardHome setup * Update README.md 2020-06-14 14:43:31 +00:00			`### AdguardHome`
Update README.md 2020-07-05 20:54:53 +00:00			`Run AdguardHome on your UDM with podman.`
Linking other useful projects. 2020-07-07 05:44:54 +00:00
			`## Cool projects you can use with this`

			`### multicast-relay`
			`https://hub.docker.com/r/scyto/multicast-relay`
			`This is a docker container that implements https://github.com/alsmith/multicast-relay to provide mDNS and SSDP on a unfi dream machine. It will likely work on any multi homed host.`

			`### ntopng`
			`https://github.com/tusc/ntopng-udm`
			`Much better network stats for your UDM/P! Install this docker container and create an on_boot script to make sure it's always running.`