Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unifi-utilities/uxg-boot
UXG-Pro implementation of on-boot-script from udm-utilities
https://github.com/unifi-utilities/uxg-boot
ubiquiti udm-utilities unifi uxg uxg-pro
Last synced: about 2 months ago
JSON representation
UXG-Pro implementation of on-boot-script from udm-utilities
- Host: GitHub
- URL: https://github.com/unifi-utilities/uxg-boot
- Owner: unifi-utilities
- License: gpl-3.0
- Created: 2022-06-10T02:56:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-18T07:58:38.000Z (over 1 year ago)
- Last Synced: 2024-06-11T19:09:34.630Z (7 months ago)
- Topics: ubiquiti, udm-utilities, unifi, uxg, uxg-pro
- Language: Shell
- Homepage:
- Size: 75.2 KB
- Stars: 19
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# uxg-boot
## This approach doesn't work anymore, see #18. See also https://github.com/unifi-utilities/unifios-utilities/issues/523
Enables custom boot scripts for the [UniFi UXG-Pro][uxg-pro]. Inspired by
[`on-boot-script`][on-boot-script] from [`udm-utilities`][udm-utilities] and
based on ideas from boostchicken-dev/udm-utilities#356. Intended to be fully
compatible with [`udm-utilities`][udm-utilities], such that all of the scripts
from the original repository should work verbatim.
Tested on the following firmware versions:
- 1.11.0
- 1.12.19
- 1.13.6
## Installation
### Automatic
You can install `uxg-boot` by running the following command on your UXG-Pro.
```sh
curl -fLSs https://raw.githubusercontent.com/unifi-utilities/uxg-boot/master/install.sh | sh
```
### Manual
```sh
VERSION=$(podman image inspect --format '{{ .Labels.version }}' uxg-setup:default)
uxg-setup update joshuaspence/uxg-setup:$(VERSION)
```
## Uninstallation
### Automatic
```sh
curl -fLSs https://raw.githubusercontent.com/unifi-utilities/uxg-boot/master/install.sh | sh -s uninstall
```
### Manual
```sh
podman image tag uxg-setup:latest uxg-setup:default
uxg-setup reset
```
## Usage
Once installed, any executable files in `/mnt/data/on_boot.d` will be executed
when the `uxg-setup` container is started. As the `uxg-setup` container could
be started multiple times (e.g. by being restarted), boot scripts should be
idempotent.
```sh
#!/bin/sh
podman container exists multicast-relay || podman create --detach --name multicast-relay --network host --restart always scyto/multicast-relay:latest
podman start multicast-relay
```
[on-boot-script]: https://github.com/boostchicken-dev/udm-utilities/blob/master/on-boot-script/README.md
[udm-utilities]: https://github.com/boostchicken-dev/udm-utilities
[uxg-pro]: https://store.ui.com/products/unifi-next-generation-gateway-professional