Skip to content

Commit

Permalink
Update README.md (unifi-utilities#535)
Browse files Browse the repository at this point in the history
  • Loading branch information
boostchicken authored Apr 17, 2023
1 parent f9361f4 commit c53545c
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Branches
1. [1.12.x](https://github.com/unifi-utilities/unifios-utilities/tree/v1.12.x) - Support for 1.x.x firmware line
1. [main](https://github.com/unifi-utilities/unifios-utilities) - Support for 2.5.x and above
1. [main](https://github.com/unifi-utilities/unifios-utilities) - Support for 2.4.x and above

### Current Branch is main, supporting 2.5.x
-----
Expand All @@ -31,7 +31,9 @@ Standard Image for base UDM, systemd removed

### UDM Pro / SE
Base build with apparmor, systemd, devicemapper removal, and overlay kept

Works on PRO on 2.x, for 1.x use the UDM Base still.

*Does not work on 3.x use nspawn-container*

## macvlan kernel module for UDR
Expand All @@ -55,10 +57,11 @@ Enables containers on UniFiOS 3.x, this replaces podman.

### 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.

Works on PRO on 2.x, for 1.x use the UDM Base still.
*Does not working on 3.x use nspawn-container*

**Does not working on 3.x use nspawn-container**

### container-common

Expand All @@ -70,11 +73,6 @@ Updates container defaults to maintain **stable disk usage footprint** of custom

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

### UDM Persistent SSH Keys Script

<https://github.com/fire1ce/UDM-Persistent-SSH-Keys>

Script to persist ssh keys after reboot or firmware update.

## VPN Servers / Clients
| Name | URL | Description |
Expand Down Expand Up @@ -148,7 +146,7 @@ Update your cloudflare domains from your UDM with podman.
|------ |----- |------------- |
|suricata | | Updates suricata to a recent version. Now in firmware |
| Jumbo Frames | <https://github.com/kalenarndt/udmp-jumbo-frames> | native jumbo frame support for the UDM and UDM-Pro is added in the 1.12.13 EA firmware, support for the UDM-SE is not yet announced. |

| UDM Persistent SSH Keys Script | <https://github.com/fire1ce/UDM-Persistent-SSH-Keys> | Stores SSH Keys. This functionality is now in firmware

## Reimaging your UDM

Expand Down

0 comments on commit c53545c

Please sign in to comment.