Repository files navigation

View Chinese description |查看中文说明

This plugin supports online management of Amlogic S9xxx series (X96, HK1, H96, etc.), Allwinner (V-Plus Cloud), and Rockchip (BeikeYun, Chainedbox-L1-Pro, FastRhino-R66S/R68S, Radxa-5B/E25) boxes. It also works in OpenWrt installed in the KVM virtual machine of the Armbian system. Current features includeinstall OpenWrt to EMMC,manually uploading/updating online OpenWrt firmware or kernel versions,backup/restore OpenWrt configuration,snapshot management, andcustomizing firmware/kernel download site, etc.

Using the OpenWrt system and Amlogic box plugin in the box requires the support of somerequired software packages. Whencustom compiling OpenWrt, please add it according to the instructions. When using the one-click script formanual installation in OpenWrt without compiling Amlogic's box, if there is a prompt for missing dependencies, please install the dependencies according to the log prompt (System >Software Packages >Refresh List >Search for the corresponding package >Install), thenretry.

• If the OpenWrt you are currently using does not have this plugin, you can also install it manually. Use SSH to log in to any directory of the OpenWrt system, or inSystem Menu →TTYD Terminal, run the one-click installation command to automatically download and install this plugin.

curl -fsSL git.io/luci-app-amlogic | bash

# Add the pluginrm -rf package/luci-app-amlogicgit clone https://github.com/ophub/luci-app-amlogic.git package/luci-app-amlogic# You can compile this plugin separatelymake package/luci-app-amlogic/compile V=99# Or integrate this plugin during the full compilation of OpenWrtmake menuconfig# choose LuCI ---> 3. Applications  ---> <*> luci-app-amlogic ----> savemake V=99

• It supports OpenWrt firmware packaged byflippy andophub related scripts. The download addresses ofOpenWrt firmware andkernel files inonline download update of the plugin can be customized as your own github.com repository. Configuration information is saved in the/etc/config/amlogic file. During the compilation of OpenWrt firmware, you can directly modify the related values in this file:

# 1. Set the download repository of OpenWrt filessed -i"s|amlogic_firmware_repo.*|amlogic_firmware_repo 'https://github.com/USERNAME/REPOSITORY'|g" package/luci-app-amlogic/root/etc/config/amlogic# 2. Set the keyword of Tags in Releasessed -i"s|ARMv8|RELEASES_TAGS_KEYWORD|g" package/luci-app-amlogic/root/etc/config/amlogic# 3. Set the suffix of OpenWrt file in Releasessed -i"s|.img.gz|.OPENWRT_SUFFIX|g" package/luci-app-amlogic/root/etc/config/amlogic# 4. Set the download path of OpenWrt kernelsed -i"s|amlogic_kernel_path.*|amlogic_kernel_path 'https://github.com/USERNAME/REPOSITORY'|g" package/luci-app-amlogic/root/etc/config/amlogic

• When you are compiling OpenWrt, modifying the above 4 points can achieve customization. You can also modify the above information after logging into the OpenWrt system, inSystem →Amlogic Box settings.

The plugin settings consist of 4 elements: OpenWrt firmware download address, kernel download address, version branch selection, and others.

1. OpenWrt firmware download repository: Fill in your repository on github where you compile OpenWrt (or other compiler's repository), such as:https://github.com/breakingbadboy/OpenWrt. TheOpenWrt Compiler author button on the plugin's welcome homepage will link to the website filled in here (automatically updates the link according to the filled website), making it easy for everyone to find the firmware compiler for exchange and learning.

2. Tags keywords in Releases: It needs to distinguish other x86, R2S, etc. firmwares, and ensure that this keyword can find the corresponding OpenWrt firmware.

3. Suffix of OpenWrt file: Supported formats include.img.gz /.img.xz /.7z. However, .img is not supported because it is too large and slow to download.

• When naming theOpenWrt firmware in Releases, please includeSOC model andkernel version: openwrt_{soc}_ xxx_{kernel}_ xxx.img.gz, for example: openwrt_s905d_ n1_R21.8.6_k5.15.25-flippy-62+o.7z. SupportedSOC includes:s905x3,s905x2,s905x,s905w,s905d,s922x,s912,l1pro,beikeyun,vplus. Supportedkernel versions include5.10.xxx,5.15.xxx, etc.

• OpenWrt Kernel Download Repository: You can provide the full pathhttps://github.com/breakingbadboy/OpenWrt or the shorthandbreakingbadboy/OpenWrt. The plugin will automatically download kernels corresponding to specific tags from Releases on Github.com. For instance, it will download the universal kernel fromkernel_stable, the rk3588 specialized kernel fromkernel_rk3588, and the rk35xx specialized kernel fromkernel_rk35xx, among others.
• Custom Kernel Download Tags: You can addKERNELTAGS='xxx' to the/etc/flippy-openwrt-release file in the OpenWrt system to specify the fixed Tags for kernel downloads. If specified, the plugin will automatically download kernels from the designatedkernel_xxx in Releases. For example, whenKERNELTAGS='flippy' is specified, kernels will be automatically downloaded fromkernel_flippy. When making custom settings, ensure that this Tag exists in the kernel download repository.

• Set version branch: The default is the branch of the current OpenWrt firmware. You can freely choose other branches or customize the branch, such as5.10,5.15, etc. TheOpenWrt andKernel[Online Download Update] will download and update according to the branch you selected.

• Keep configuration update: Modify as needed. If checked, the current configuration will be retained when updating the firmware.

• Automatically write bootloader: Recommended to be checked, it has many features.

• Set file system type: Set the file system type of the shared partition (/mnt/mmcblk*p4) when installing OpenWrt (default is ext4). This setting only applies to fresh installations of OpenWrt, and will not change the file type of the current shared partition when updating the kernel and firmware.

• The default OpenWrt firmware (Plugin Full Version |Selected Plugins Mini Version |Flippy Shared Version) andKernel download service are provided bybreakingbadboy, who is an active and enthusiastic manager in the Flippy community, familiar with OpenWrt compilation, and proficient in the installation and use of various series of boxes supported byFlippy. For issues encountered in the compilation and use of OpenWrt, you can consult in the community or give feedback on his Github.

• The kernel will be deprecated after the update cycle, and you can choose to use the kernel ofany other version in theplugin settings. Some kernels do not have a complete firmware, you can change the kernel branch in theplugin settings and choose the version branch corresponding to the download address.

The plugin has 6 functions: Install OpenWrt, Manual Upload Update, Online Download Update, Firmware Configuration Backup, Plugin Settings, and CPU Settings.

1. Install OpenWrt: Select your device from theSelect Device Model list, and clickInstall to write the firmware from TF/SD/USB into the built-in eMMC of the device.

2. Manual Upload Update: Click theChoose File button, select the localOpenWrt Kernel (upload the full set of kernel files) orOpenWrt Firmware (recommended to upload compressed firmware), and upload. Once the upload is complete, the correspondingReplace OpenWrt Kernel orUpdate OpenWrt Firmware button will appear at the bottom of the page, click to update (the system will automatically reboot after the update).

3. Online Download Update: Click theUpdate Box Plugin Only button to update the Amlogic Box plugin to the latest version; clickUpdate System Kernel Only to download the corresponding kernel according to the kernel branch selected inPlugin Settings; clickFull System Update to download the latest firmware based on the download site set inPlugin Settings. Clicking theRescue the original system kernel button will copy the kernel currently in use on the device to the target disk. This facilitates rescue operations in case a kernel update fails and the OpenWrt system cannot start. For example, it allows for booting the OpenWrt system from a USB drive to rescue the system on the eMMC, supporting mutual rescue amongeMMC/NVME/sdX devices.

4. Backup Firmware Configuration: Click theOpen List button to edit the backup list; click theDownload Backup button to backup the OpenWrt configuration information from the current device to local; click theUpload Backup button to upload the backup configuration files and restore the system configuration. ClickCreate Snapshot,Restore Snapshot andDelete Snapshot buttons to manage the snapshot accordingly. Snapshots will record all configuration information in the/etc directory of the current OpenWrt system, which is convenient for one-click restore to the current configuration status in the future. This function is similar toDownload Backup, but only saves in the current system and does not support download use.

5. Plugin Settings: Set the kernel download address and other information of the plugin, for details, see the relevant introduction inPlugin Settings Instructions.

6. CPU Settings: Set the scheduling policy of the CPU (recommended to use the default settings), which can be set according to needs.

Note:Install OpenWrt andCPU Settings and other functions will automatically hide inapplicable functions depending on the device and environment.

For overpowered boxes, you can first install theArmbian system, then install the KVM virtual machine to achieve multi-system use. The compilation of the OpenWrt system can use themk_qemu-aarch64_img.sh script developed byunifreq, and its installation and use instructions are detailed in theqemu-aarch64-readme.md document. The OpenWrt qemu firmware inOnline Download Update is supported bybreakingbadboy.

The method of using the plugin in the KVM virtual machine is the same as the method of directly installing and using OpenWrt in the box.

Step 1: Compile the Rootfs file for OpenWrt: Use the OpenWrt source code and selectArm SystemReady (EFI) compliant option inTarget System, select64-bit (armv8) machines option inSubtarget, selectGeneric EFI Boot option inTarget Profile, and add therequired software packages to compile therootfs.tar.gz file for OpenWrt.

Step 2: Package the dedicated OpenWrt firmware for different devices: You can use the scripts fromflippy orophub to package the dedicated OpenWrt firmware for different devices. Please refer to the respective repositories for detailed usage instructions.

• Kernel and scripts resources are fromunifreq
• File upload and download functions were inspired byluci-app-filetransfer
• CPU settings function was inspired byluci-app-cpufreq

• OpenWrt
• coolsnowwolf/lede
• immortalwrt
• unifreq/openwrt_packit
• breakingbadboy/OpenWrt

The luci-app-amlogic © OPHUB is licensed underGPL-2.0