[GH-ISSUE #335] Misleading Docs and Error Messages #186

Closed
opened 2026-02-26 12:07:34 +03:00 by kerem · 8 comments
Owner

Originally created by @anonhostpi on GitHub (Mar 24, 2024).
Original GitHub issue: https://github.com/0xJacky/nginx-ui/issues/335

Originally assigned to: @Hintay on GitHub.

Describe the bug
This line of the install script appears to be misleading:
github.com/0xJacky/nginx-ui@aeed27a2fa/install.sh (L172)

as it conflicts with this statement of the readme:
github.com/0xJacky/nginx-ui@aeed27a2fa/README.md (L149)

To Reproduce
Attempt to use install.sh on OpenWRT

Expected behavior
Inform the user that OpenWRT is supported, but must be extracted or built manually.

Screenshots
If applicable, add screenshots to help explain your problem.

Info (please complete the following information):

  • Server OS: OpenWrt 23.05.2
  • Server Arch: x86/64
  • Nginx UI Version: v2.0.0-beta.18-patch.2
  • Your Browser: N/A

Additional context
OpenWRT does not include systemd

Originally created by @anonhostpi on GitHub (Mar 24, 2024). Original GitHub issue: https://github.com/0xJacky/nginx-ui/issues/335 Originally assigned to: @Hintay on GitHub. **Describe the bug** This line of the install script appears to be misleading: https://github.com/0xJacky/nginx-ui/blob/aeed27a2fa70f9e60d72aa33e3f20d648b5292cb/install.sh#L172 as it conflicts with this statement of the readme: https://github.com/0xJacky/nginx-ui/blob/aeed27a2fa70f9e60d72aa33e3f20d648b5292cb/README.md?plain=1#L149 **To Reproduce** Attempt to use install.sh on OpenWRT **Expected behavior** Inform the user that OpenWRT is supported, but must be extracted or built manually. **Screenshots** If applicable, add screenshots to help explain your problem. **Info (please complete the following information):** - Server OS: OpenWrt 23.05.2 - Server Arch: x86/64 - Nginx UI Version: v2.0.0-beta.18-patch.2 - Your Browser: N/A **Additional context** OpenWRT does not include systemd
kerem 2026-02-26 12:07:34 +03:00
Author
Owner

@anonhostpi commented on GitHub (Mar 24, 2024):

Also I made a tutorial on how to get this to work on OpenWRT: https://www.reddit.com/r/linux/comments/1bmcsz0/howto_nginxui_on_openwrt_without_building/

<!-- gh-comment-id:2016694766 --> @anonhostpi commented on GitHub (Mar 24, 2024): Also I made a tutorial on how to get this to work on OpenWRT: https://www.reddit.com/r/linux/comments/1bmcsz0/howto_nginxui_on_openwrt_without_building/
Author
Owner

@Hintay commented on GitHub (Mar 24, 2024):

Thank you for your tutorial. I'd like to inform you that you can directly download the pre-build executable binary for your architecture from the release page.

The current installation script does not support Linux distributions without systemd. I understand the inconvenience this may cause, and I assure you that I am working on updating the script to support OpenWRT in the next version.

<!-- gh-comment-id:2016861144 --> @Hintay commented on GitHub (Mar 24, 2024): Thank you for your tutorial. I'd like to inform you that you can directly download the pre-build executable binary for your architecture from the [release](https://github.com/0xJacky/nginx-ui) page. The current installation script does not support Linux distributions without `systemd`. I understand the inconvenience this may cause, and I assure you that I am working on updating the script to support OpenWRT in the next version.
Author
Owner

@anonhostpi commented on GitHub (Mar 25, 2024):

The issue is more of a lack of specificity. The install script makes it look like nginx-ui isn't supported at all, instead of just not being supported by the installer.

<!-- gh-comment-id:2017086409 --> @anonhostpi commented on GitHub (Mar 25, 2024): The issue is more of a lack of specificity. The install script makes it look like nginx-ui isn't supported at all, instead of just not being supported by the installer.
Author
Owner

@anonhostpi commented on GitHub (Mar 25, 2024):

If you were curious about the technicals, OpenWRT uses init scripts instead of systemd service files

The services defined in /etc/init.d/ are literally shell scripts that use rc.common to bootstrap them and make them behave like services

The service command functions as an alias/wrapper for /etc/init.d/<service> <command> (service <service> <command>)

<!-- gh-comment-id:2017294827 --> @anonhostpi commented on GitHub (Mar 25, 2024): If you were curious about the technicals, OpenWRT uses init _scripts_ instead of systemd service _files_ The services defined in /etc/init.d/ are literally shell scripts that use rc.common to bootstrap them and make them behave like services The service command functions as an alias/wrapper for `/etc/init.d/<service> <command>` (`service <service> <command>`)
Author
Owner

@Hintay commented on GitHub (Nov 5, 2024):

We've updated the install script to clarify the error message. We’re also considering compiling Nginx UI into an ipk package for OpenWRT.

<!-- gh-comment-id:2457330571 --> @Hintay commented on GitHub (Nov 5, 2024): We've updated the install script to clarify the error message. We’re also considering compiling Nginx UI into an ipk package for OpenWRT.
Author
Owner

@1102731636 commented on GitHub (Feb 28, 2025):

我们更新了安装脚本以澄清错误消息。我们还在考虑将 Nginx UI 编译成 OpenWRT 的 ipk 包。

[\e]0;\u@\h: \w\a]\u@\h:\w$ bash -c "$(curl -L ${GH_PROXY}https://ghfast.top/raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ install
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 14113 100 14113 0 0 12450 0 0:00:01 0:00:01 --:--:-- 12489
error: Only Linux distributions using systemd are supported by this script.
error: Please download the pre-built binary from the release page or build it manually.

<!-- gh-comment-id:2690691801 --> @1102731636 commented on GitHub (Feb 28, 2025): > 我们更新了安装脚本以澄清错误消息。我们还在考虑将 Nginx UI 编译成 OpenWRT 的 ipk 包。 \[\e]0;\u@\h: \w\a\]\u@\h:\w\$ bash -c "$(curl -L ${GH_PROXY}https://ghfast.top/raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ install % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 14113 100 14113 0 0 12450 0 0:00:01 0:00:01 --:--:-- 12489 error: Only Linux distributions using systemd are supported by this script. error: Please download the pre-built binary from the release page or build it manually.
Author
Owner

@anonhostpi commented on GitHub (Mar 8, 2025):

We've updated the install script to clarify the error message. We’re also considering compiling Nginx UI into an ipk package for OpenWRT.

FYI, this effort may possibly not be required as OpenWRT is allegedly moving to Alpine's APK: https://linuxiac.com/openwrt-adopts-apk-as-new-package-manager/

<!-- gh-comment-id:2707817624 --> @anonhostpi commented on GitHub (Mar 8, 2025): > We've updated the install script to clarify the error message. We’re also considering compiling Nginx UI into an ipk package for OpenWRT. FYI, this effort may _possibly_ not be required as OpenWRT is allegedly moving to Alpine's APK: https://linuxiac.com/openwrt-adopts-apk-as-new-package-manager/
Author
Owner

@NicholasFlamy commented on GitHub (Dec 19, 2025):

We've updated the install script to clarify the error message. We’re also considering compiling Nginx UI into an ipk package for OpenWRT.

FYI, this effort may possibly not be required as OpenWRT is allegedly moving to Alpine's APK: https://linuxiac.com/openwrt-adopts-apk-as-new-package-manager/

They opened the new branch. Now is the time to get the package into the next release @0xJacky.

<!-- gh-comment-id:3676103761 --> @NicholasFlamy commented on GitHub (Dec 19, 2025): > > We've updated the install script to clarify the error message. We’re also considering compiling Nginx UI into an ipk package for OpenWRT. > > FYI, this effort may _possibly_ not be required as OpenWRT is allegedly moving to Alpine's APK: https://linuxiac.com/openwrt-adopts-apk-as-new-package-manager/ They opened the new branch. Now is the time to get the package into the next release @0xJacky.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/nginx-ui#186
No description provided.