From 5db2bc5c23abb878a24e797acd6a2c6cdfb36bda Mon Sep 17 00:00:00 2001 From: John D Date: Tue, 25 May 2021 10:40:39 -0700 Subject: [PATCH] Documentation fixes Former-commit-id: cc56791b0138042d10a6042ae0e8c5154a621116 --- README.md | 14 +++++++++----- nextdns/README.md | 2 +- on-boot-script/README.md | 7 ++++++- podman-update/README.md | 5 +++-- 4 files changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 777cb95..1f8568a 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,9 @@ If you want to do a custom kernel with wireguard support, multicast, multipath r 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.** +### podman-update +Updates Podman, conmon, and runc to a recent version. This allows docker-compose usage as well. + ### 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**. @@ -39,11 +42,7 @@ Base configuration for DNS server containers, both IPv4 and IPv6. Utilizes MacV ### run-pihole -Run pihole on your UDM with podman. - -### nextdns - -Run NextDNS on your UDM with podman. +Run pihole on your UDM with podman. Also contains custom image for Pihole with cloudflared ### AdguardHome @@ -91,3 +90,8 @@ This is a docker container that implements 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. + + +## Unsupported / No longer maintained +### nextdns +Run NextDNS on your UDM with podman. diff --git a/nextdns/README.md b/nextdns/README.md index 585acb3..b4a866a 100644 --- a/nextdns/README.md +++ b/nextdns/README.md @@ -1,5 +1,5 @@ # Run NextDNS on your UDM -# THIS IS NO LONGER MAINTAINED +# THIS IS NO LONGER MAINTAINED. VENDOR PROVIDES DIRECT SUPPORT ## Features 1. Run NextDNS on your UDM with a completely isolated network stack. This will not port conflict or be influenced by any changes on by Ubiquiti. diff --git a/on-boot-script/README.md b/on-boot-script/README.md index 545169c..e76c8f2 100644 --- a/on-boot-script/README.md +++ b/on-boot-script/README.md @@ -23,7 +23,7 @@ * [build_deb.sh](build_deb.sh) can be used to build the package by yourself. * [dpkg-build-files](dpkg-build-files) contains the sources that debuild uses to build the package if you want to build it yourself / change it * by default it uses docker or podman to build the debian package - * use ```./build_deb.sh build``` to not using a container + * use ```./build_deb.sh build``` to not use a container * the resulting package will be in [packages/](packages/) * Built on Ubuntu-20.04 on Windows 10/WSL2 @@ -53,6 +53,11 @@ ## Version History +### 1.0.5 + +* Remove on_boot.sh from UDM +* Follow symlinks + ### 1.0.4 * Fix 600s timeout issues diff --git a/podman-update/README.md b/podman-update/README.md index 48789bf..83d68a5 100644 --- a/podman-update/README.md +++ b/podman-update/README.md @@ -20,10 +20,11 @@ minecraft_1 | [init] Starting the Minecraft server... ## Requirements 1. You have successfully set up the on boot script described [here](https://github.com/boostchicken/udm-utilities/tree/master/on-boot-script) +1. [05-install-cni-plugins.sh](../cni-plugins/05-install-cni-plugins.sh) installed ## Customization -* You can not expose the docker daemon by commenting out the podman service in [00-podman-update.sh](01-podman-update.sh) +* You can disable exposing the docker daemon by commenting out the podman service in [01-podman-update.sh](01-podman-update.sh) ## Podman Build Process * This is a custom-built binary by me. It was cross compiled on Ubuntu-20.04 in WSL2. @@ -57,7 +58,7 @@ OS/Arch: linux/arm64 ``` ## Docker Compose -There is no docker-compose binary to run on the UDMP yet, so please use docker-compose from a remote system and specify to run on your UDM. +There is no docker-compose binary to run on the UDM yet, so please use docker-compose from a remote system and specify to run on your UDM. ```docker-compose -H 10.0.0.1:2375 up```