English Instructions | 中文说明

FnNAS is a deeply customized operating system built on the latest Linux kernel (Debian distribution). It offers excellent hardware compatibility with comprehensive support for mainstream x86 and Arm64 devices, enabling users to build their own NAS and flexibly expand external storage. Now, you can easily replace the Android TV system on your TV box with FnNAS, transforming it into a powerful private data storage server.

This project benefits from the sustained contributions of numerous contributors. Under the guidance of FnNAS official technical experts, we have built an FnNAS system adapted for Arm64 architecture, covering TV boxes powered by Amlogic, Rockchip, and Allwinner SoCs. The build version fully inherits all features of the official system, with support for writing to eMMC boot and online kernel updates. Please visit the Releases page to download the latest firmware. You are welcome to Fork this project for personalized customization. If this project is helpful to you, please click the Star ⭐ in the upper right corner of the repository to show your support!

FnNAS Firmware Default Information

Supported Device List

⬆️ Models for each platform (Amlogic/Rockchip/Allwinner) are arranged by SoC performance from high to low.

[!TIP] Currently, s905 series boxes can only boot from TF/SD/USB, while other box models support writing to eMMC. For more information, please refer to the ✅Supported Device List Instructions. To add new supported devices, refer to section 12.15 in the documentation: Adding New Supported Devices.

Instructions for Installing and Upgrading FnNAS

Select the FnNAS system corresponding to your device model. Refer to the respective instructions for usage on different devices.

• Install FnNAS to eMMC

1. For Rockchip platforms, please refer to Chapter 8 of the documentation. The installation procedure is the same as Armbian.

2. For Amlogic and Allwinner platforms, use tools like Rufus or balenaEtcher to write the system image to a USB drive, then insert the prepared USB drive into the box. Check your router's management interface for a newly connected device named 'debian' and obtain its IP address (e.g., 192.168.1.15). Access http://192.168.1.15:5666 via a browser to enter the FnNAS account creation interface. After creating a custom account and logging into the FnNAS system, enable SSH in System Settings → SSH. Then use an SSH client to connect to the system terminal and execute the following commands:

sudo -i
fnnas-install

Example: fnnas-install -m yes

[!TIP] Partition option description: Custom system rootfs size is supported when available disk space exceeds 16GiB (default: 16GiB).

During system reinstallation, the script automatically detects the partition structure on the eMMC. If a personal data partition (P3) is detected, Option 3 will be activated in the partition menu. Selecting this option strictly preserves the current partition table layout, ensuring that data within the P3 partition is not overwritten. After installation, you can directly mount and access this partition via the 'Storage Manager' interface in FnNAS.

• Update FnNAS Kernel

Login to FnNAS system SSH terminal → Execute the following commands:

sudo -i
fnnas-update

Example: fnnas-update -k 6.18.18

When specifying the kernel version via the -k parameter, you can specify an exact version number, e.g., fnnas-update -k 6.18.18, or specify a kernel series prefix, e.g., fnnas-update -k 6.18. When a series prefix is specified, the latest version within that series will be used automatically.

When updating the kernel, the current kernel is automatically backed up in the /ddbr/backup directory. The last 3 kernel versions are retained. If the newly installed kernel is unstable, you can roll back to a backed-up kernel at any time. If a kernel update causes the system to fail to boot, you can restore the system kernel via fnnas-update -s.

• Create Swap for FnNAS

When running memory-intensive applications such as docker, if the device's memory is insufficient, you can create a swap partition to use a portion of disk space as virtual memory. The parameter unit for the command below is GB, with a default value of 1.

Login to FnNAS system SSH terminal → Execute the following command:

fnnas-swap 1

• Control LED Display

Login to FnNAS system SSH terminal → Execute the following command:

fnnas-openvfd

Refer to the LED Screen Display Control Instructions for configuration.

• Backup/Restore eMMC Original System

Supports backing up and restoring the box's eMMC via TF/SD/USB boot. It is recommended to back up the original Android TV system before installing FnNAS on a new device, so the original system can be restored if needed.

Please boot the FnNAS system from TF/SD/USB → Execute the following command:

fnnas-ddbr

Enter b when prompted to back up the system, or r to restore.

[!IMPORTANT] Alternatively, you can flash the Android system into eMMC via USB flashing. Android system images can be obtained from Tools.

• Sync Latest Service Scripts

To update all service scripts in the system to the latest version, login to FnNAS system SSH terminal → Execute the following command:

fnnas-sync

Local Packaging

1. Clone the repository locally: git clone --depth 1 https://github.com/ophub/fnnas.git

2. Install necessary dependencies (e.g., Ubuntu 24.04):

sudo apt-get update -y
sudo apt-get full-upgrade -y
# For Ubuntu-24.04
sudo apt-get install -y $(cat make-fnnas/script/ubuntu2404-make-fnnas-depends)

3. Enter the ~/fnnas root directory, create a fnnas-arm64 folder, and place the FnNAS image file (e.g., fnos_arm_1.0.0_258.img) into the ~/fnnas/fnnas-arm64 directory.

4. In the ~/fnnas root directory, run sudo ./renas -b s905x3 -k 6.18.18 to generate the FnNAS image file for the specified board. The generated files are saved in the ~/fnnas/out directory.

• Local Packaging Parameter Description

• sudo ./renas : Use default configuration to package for all TV box models.
• sudo ./renas -b s905x3 -k 6.18.18 : Recommended. Package with the specified kernel using default configuration.
• sudo ./renas -b s905x3 -k 6.18.y : Use default configuration, automatically using the latest version of the 6.18.y series kernel.
• sudo ./renas -b s905x3 -k 6.18.18 -s 6144 : Use default configuration, specify one kernel and one model for packaging, with the system partition size set to 6144 MiB.
• sudo ./renas -b s905x3_s905d : Use default configuration to package all kernels for multiple TV box models. Use _ to join multiple models.
• sudo ./renas -b s905x3 -e 32 : Use default configuration to package for the s905x3 model, with the rootfs automatic expansion size set to 32 GiB.

Building Images via GitHub Actions

1. Workflow configuration files are located in .github/workflows.

2. On the Actions page, select Build FnNAS Image to compile using build-fnnas-image.yml. Click the Run workflow button to start the build. In the options panel, you can set the FnNAS image download URL in Custom fnnas image download url, e.g., https://fnnas.com/.../fnos_arm_1.0.0_258.img.xz. If not specified, the official image stored in fnnas_base_image will be used by default.

- name: Build FnNAS Image
  uses: ophub/fnnas@main
  with:
    build_target: fnnas
    fnnas_path: fnnas/*.img.xz
    fnnas_board: s905d_s905x3_s922x_s905x
    fnnas_kernel: 6.18.y
    rootfs_expand: 16

• GitHub Actions Image Build Parameter Description

The parameters correspond to the local packaging commands described above.

• Local FnNAS Kernel Build Parameter Description

• sudo ./rekernel : Uses default configuration. Does not install debs kernel packages or supplement dtbs files; packages the kernel from the current FnNAS image directly.
• sudo ./rekernel -e amlogic : Installs the amlogic debs kernel packages into the current system, then proceeds with kernel packaging.
• sudo ./rekernel -t true : Installs additional dtbs files (missing from official sources) into the current system, then proceeds with kernel packaging.
• sudo ./rekernel -e allwinner -t false : Installs the allwinner debs kernel packages into the current system without installing additional dtbs files, then proceeds with kernel packaging.

Building FnNAS Kernel via GitHub Actions

For details on compiling the FnNAS-specific kernel, please refer to build-fnnas-kernel.yml.

- name: Build FnNAS Kernel
  uses: ophub/fnnas@main
  with:
    build_target: kernel
    fnnas_path: fnnas/*.img
    dtbs_install: true
    dtbs_version: 6.18.y

The parameters correspond to the local packaging commands described above.

• GitHub Actions Output Variable Description

FnNAS image and kernel builds use the same output parameters.

Uploading to Releases requires setting Workflow Read and Write Permissions for the repository. See Usage Instructions for details.

FnNAS Contributors

First of all, thanks to experts like coolsnowwolf and unifreq for providing technical guidance on adapting this project for FnNAS. Also, thanks to the numerous contributors for their support of the Armbian/OpenWrt systems. This project directly inherited and utilized the resources and technical solutions from these projects during the FnNAS adaptation process. Thank you all for your contributions and sharing, enabling FnNAS to run on more devices.

The u-boot, kernel, and firmware resources used in this system are primarily sourced from the unifreq/openwrt_packit project. Some files were contributed and shared by users through Pull and Issues in projects such as amlogic-s9xxx-armbian / amlogic-s9xxx-openwrt / fnnas / luci-app-amlogic / kernel / u-boot. To acknowledge these pioneers and contributors, they have been recorded in CONTRIBUTORS.md. Thank you again for giving new life and value to these devices.

Other Distributions

• The amlogic-s9xxx-armbian project provides the Armbian system for TV boxes, which is also applicable to FnNAS-compatible devices.
• The amlogic-s9xxx-openwrt project provides the OpenWrt system for TV boxes, which is also applicable to FnNAS-compatible devices.
• unifreq has created OpenWrt systems for various boxes including Amlogic, Rockchip, and Allwinner. It is a benchmark project in the TV box community and is highly recommended.
• cooip-jm shared extensive guides on Armbian, OpenWrt, LXC, Docker, AdGuard, and other applications in his wiki, which is recommended for reference.

Links

• fnnas.com
• unifreq
• coolsnowwolf

License

The fnnas © OPHUB is licensed under GPL-2.0