nginx-ui icon indicating copy to clipboard operation
nginx-ui copied to clipboard

Misleading Docs and Error Messages

Open anonhostpi opened this issue 1 year ago • 4 comments

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

anonhostpi avatar Mar 24 '24 02:03 anonhostpi

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/

anonhostpi avatar Mar 24 '24 05:03 anonhostpi

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.

Hintay avatar Mar 24 '24 16:03 Hintay

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.

anonhostpi avatar Mar 25 '24 02:03 anonhostpi

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>)

anonhostpi avatar Mar 25 '24 06:03 anonhostpi