Mirrored_Repos/unifios-utilities
1
0
Fork 0
mirror of https://github.com/unifi-utilities/unifios-utilities.git synced 2024-08-30 18:32:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up the markdown

Browse Source
This commit is contained in:
Johann Christensen 2022-02-24 09:26:04 +01:00 committed by GitHub
parent 9aba2f1483
commit 0ff5a06957
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 49 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -1 +1,3 @@
All pull requests on any content are welcome! Anything you find useful. I will review all PRs, just please include what your changes does and why you did it. All pull requests on any content are welcome!
Anything you find useful.
I will review all PRs, just please include what your changes does and why you did it.

66
README.md
View File

@ -1,20 +1,23 @@
# udm-utilities [![Discord](https://img.shields.io:/discord/939817841107034172?label=Discord&logo=Discord&style=for-the-badge "Discord")](https://discord.gg/8zqrQJFghg) # udm-utilities [![Discord](https://img.shields.io:/discord/939817841107034172?label=Discord&logo=Discord&style=for-the-badge "Discord")](https://discord.gg/8zqrQJFghg)
[![UDMP Podman](https://github.com/boostchicken/udm-utilities/actions/workflows/podman-udmp.yml/badge.svg)](https://github.com/boostchicken/udm-utilities/actions/workflows/podman-udmp.yml) [![UDMPSE Podman](https://github.com/boostchicken/udm-utilities/actions/workflows/podman-udmse.yml/badge.svg?branch=master)](https://github.com/boostchicken/udm-utilities/actions/workflows/podman-udmse.yml) [![UDM-Pro Podman](https://github.com/boostchicken/udm-utilities/actions/workflows/podman-udmp.yml/badge.svg)](https://github.com/boostchicken/udm-utilities/actions/workflows/podman-udmp.yml)
[![UDM-SE Podman](https://github.com/boostchicken/udm-utilities/actions/workflows/podman-udmse.yml/badge.svg?branch=master)](https://github.com/boostchicken/udm-utilities/actions/workflows/podman-udmse.yml)
A collection of things to enhance the capabilities of your Unifi Dream Machine or Dream Machine Pro. A collection of things to enhance the capabilities of your Unifi Dream Machine or Dream Machine Pro.
## Contributing ## Contributing
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! 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!
## Custom Kernel ## Custom Kernel
If you want to do a custom kernel with wireguard support, multicast, multipath routing that is now a possiblity. Please see the repo and please use at your own risk. This a much larger change than anything in this repo. If you want to do a custom kernel with wireguard support, multicast, multipath routing that is now a possiblity.
Please see the repo and please use at your own risk. This a much larger change than anything in this repo.
[udm-kernel-tools](https://github.com/fabianishere/udm-kernel-tools) [udm-kernel-tools](https://github.com/fabianishere/udm-kernel-tools)
## Custom Podman Builds for UDMP-SE ## Custom Podman Builds for UDM-SE
<https://github.com/boostchicken/udm-utilities/actions> <https://github.com/boostchicken/udm-utilities/actions>
@ -25,17 +28,22 @@ Look at the assets on the Podman workflow.
### on-boot-script ### on-boot-script
Do this first. Enables `init.d` style scripts to run on every boot of your UDM. Includes examples to run `wpa-supplicant/eap-proxy` and/or `ntop-ng` on startup. Follow this [readme](https://github.com/boostchicken/udm-utilities/blob/master/on-boot-script/README.md). Do this first. Enables `init.d` style scripts to run on every boot of your UDM.
Includes examples to run `wpa-supplicant/eap-proxy` and/or `ntop-ng` on startup.
Follow this [readme](https://github.com/boostchicken/udm-utilities/blob/master/on-boot-script/README.md).
**It enables complete customization of your UDM/P and fills the gap that config.gateway.json left behind.** **It enables complete customization of your UDM/P and fills the gap that config.gateway.json left behind.**
### podman-update ### podman-update
Updates Podman, conmon, and runc to a recent version. This allows docker-compose usage as well. Updates Podman, conmon, and runc to a recent version.
This allows docker-compose usage as well.
### container-common ### container-common
Apply this after on-boot-script. Updates container defaults to maintain **stable disk usage footprint** of custom containers. **Prevents logs filling up UDM storage full**. Apply this after on-boot-script.
Updates container defaults to maintain **stable disk usage footprint** of custom containers.
**Prevents logs filling up UDM storage full**.
### python ### python
@ -45,7 +53,9 @@ If you need python3 on your UDM, generally not recommended, can always use it in
### wireguard-go ### 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. 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.
### WireGuard kernel module for UDM/P ### WireGuard kernel module for UDM/P
@ -63,22 +73,31 @@ OpenConnect VPN Client for the UniFi Dream Machine Pro (Unofficial).
<https://github.com/peacey/split-vpn> <https://github.com/peacey/split-vpn>
A split tunnel VPN script for the UDM with policy based routing. This helper script can be used on your UDM to route select VLANs, clients, or even domains through a VPN connection. It supports OpenVPN, WireGuard, and OpenConnect (Cisco AnyConnect) clients running directly on your UDM, and external VPN clients running on other servers on your network. A split tunnel VPN script for the UDM with policy based routing.
This helper script can be used on your UDM to route select VLANs, clients, or even domains through a VPN connection.
It supports OpenVPN, WireGuard, and OpenConnect (Cisco AnyConnect) clients running directly on your UDM, and external VPN clients running on other servers on your network.
## DNS Providers ## DNS Providers
Install a DNS server that functions as a network-wide ad and tracker blocker, and which can also securely proxy encrypted DNS requests to an upstream DNS provider. Begin by following the instructions to setup [on-boot-script](https://github.com/boostchicken/udm-utilities/tree/master/on-boot-script) and [dns-common](https://github.com/boostchicken/udm-utilities/tree/master/dns-common/on_boot.d). Then, follow the guides below to setup either Pi-Hole, NextDNS, or AdGuard Home. Install a DNS server that functions as a network-wide ad and tracker blocker, and which can also securely proxy encrypted DNS requests to an upstream DNS provider.
Begin by following the instructions to setup [on-boot-script](https://github.com/boostchicken/udm-utilities/tree/master/on-boot-script) and [dns-common](https://github.com/boostchicken/udm-utilities/tree/master/dns-common/on_boot.d).
Then, follow the guides below to setup either Pi-Hole, NextDNS, or AdGuard Home.
### dns-common ### dns-common
Base configuration for DNS server containers, both IPv4 and IPv6. Utilizes MacVLAN CNI plugins to completely isolate the network stack. Base configuration for DNS server containers, both IPv4 and IPv6.
Utilizes MacVLAN CNI plugins to completely isolate the network stack.
### run-pihole [![!Docker Pulls](https://img.shields.io/docker/pulls/boostchicken/pihole.svg?color=green&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/u/boostchicken) ### run-pihole
PiHole w/ DoH Image [![!Docker Pulls](https://img.shields.io/docker/pulls/boostchicken/pihole.svg?color=green&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/u/boostchicken)
Run Pi-hole on your UDM with podman. Also contains custom image for Pi-hole with `cloudflared`.
### PiHole with DoTe [![!Docker Pulls](https://img.shields.io/docker/pulls/boostchicken/pihole-dote.svg?color=green&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/u/boostchicken) PiHole w/ DoH Image.
Run Pi-hole on your UDM with podman.
Also contains custom image for Pi-hole with `cloudflared`.
### PiHole with DoTe
[![!Docker Pulls](https://img.shields.io/docker/pulls/boostchicken/pihole-dote.svg?color=green&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/u/boostchicken)
Desigened by: <https://github.com/chrisstaite/DoTe/> Desigened by: <https://github.com/chrisstaite/DoTe/>
@ -98,13 +117,15 @@ Update your cloudflare domains from your UDM with podman.
<https://hub.docker.com/r/scyto/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 unifi dream machine. It will likely work on any multi homed host. This is a docker container that implements <https://github.com/alsmith/multicast-relay> to provide mDNS and SSDP on a unifi dream machine.
It will likely work on any multi homed host.
### ntopng ### ntopng
<https://github.com/tusc/ntopng-udm> <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. 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.
### LetsEncrypt SSL Certs ### LetsEncrypt SSL Certs
@ -114,19 +135,24 @@ Provision and renew LetsEncrypt SSL certs from your UDM/P.
<https://github.com/alxwolf/ubios-cert> <https://github.com/alxwolf/ubios-cert>
Similar to `udm-le`, adding different providers for SSL/TLS certificates (LE, ZeroSSL, BuyPass) and DNS API (all-inkl.com) currently not supported by [LEGO]<https://go-acme.github.io/lego/dns/>. Similar to `udm-le`, adding different providers for SSL/TLS certificates (LE, ZeroSSL, BuyPass) and DNS API (all-inkl.com) currently not supported by [LEGO](https://go-acme.github.io/lego/dns/).
### Unifi API Browser ### Unifi API Browser
<https://hub.docker.com/r/scyto/unifibrowser> <https://hub.docker.com/r/scyto/unifibrowser>
This is a docker container that implements <https://github.com/Art-of-WiFi/UniFi-API-browser> to provide a graphical tool to inspect the data structures available via the unifi API. Great if you are using the REST API for your own purposes and want to explore. Works with multiple controller versions. This is a docker container that implements <https://github.com/Art-of-WiFi/UniFi-API-browser> to provide a graphical tool to inspect the data structures available via the unifi API.
Great if you are using the REST API for your own purposes and want to explore.
Works with multiple controller versions.
### Unifi UDM-Pro auto fan speed ### Unifi UDM-Pro auto fan speed
<https://github.com/renedis/ubnt-auto-fan-speed> <https://github.com/renedis/ubnt-auto-fan-speed>
A shell script with the goal to make the UDM-Pro silenced while still having good thermal values. It stops the build in service that monitors the thermal values, fan speed and connection of a HDD/SSD. After that it sets the thermal/fan chip (adt7475) to automatic mode. Once that is done it changes the thermal and fan values specified in the script. A shell script with the goal to make the UDM-Pro silenced while still having good thermal values.
It stops the build in service that monitors the thermal values, fan speed and connection of a HDD/SSD.
After that it sets the thermal/fan chip (adt7475) to automatic mode.
Once that is done it changes the thermal and fan values specified in the script.
### Jumbo Frames ### Jumbo Frames