luci-app-frps: align dashboard options with frps init script by frank-pv · Pull Request #8987 · openwrt/luci

frank-pv · 2026-08-27T14:19:07Z

Pull request details

Description

Align the LuCI frps configuration page with the option names consumed by
frps.init.

The init script uses the admin_* UCI options when generating the FRP TOML
configuration, while the LuCI page previously saved the dashboard settings
using dashboard_* option names. This caused dashboard settings changed in
LuCI to be ignored by the service.

This change:

Renames the dashboard UCI options to the corresponding admin_* names:
- admin_addr
- admin_port
- admin_user
- admin_pwd
- admin_tls_enable
- admin_tls_cert_file
- admin_tls_key_file
Updates the additional configuration file example from .ini to .toml.
Keeps compatibility with existing installations through the existing
frps.uci-defaults migration logic.

Screenshot or video of changes

Not applicable.

Maintainer

@

Tested on

OpenWrt version: Not tested on a running OpenWrt system
LuCI version: LuCI master
Web browser(s): Not tested

Checklist

Includes what Issue it closes.
Does not depend on changes in another repository.

openwrt · 2026-08-27T14:19:11Z

Formality Check: Failed

We checked this pull request against the contribution guidelines. Here is what needs your attention:

🛑 CRITICAL ERRORS

PR Targeting Violation

Pull requests must originate from a dedicated feature branch. Cannot use master directly. (A maintainer can override this check by commenting [allow branch] on this PR)

Commit 6e01ced - luci-app-frps: align dashboard options with frps init script:

Author name format is invalid ('Steven'). Please set your full name (first and last, e.g. 'Jane Doe').

Committer name format is invalid ('Steven'). Please set your full name (first and last, e.g. 'Jane Doe').

Commit author email 'admin@linbei.vip' is not linked to any registered GitHub account. Please add and verify this email in your GitHub profile settings.

Commit description body is empty or contains only trailers (e.g. Signed-off-by). Please provide a meaningful description of what this change does and why

Missing 'Signed-off-by:' line. Please add a line at the end of the commit message in the format 'Signed-off-by: Your Name your@email.com', matching your commit author or committer identity.

Tip

Do not close this pull request to make corrections. Instead, modify your existing commits (e.g. git commit --amend) and update the branch using git push --force-with-lease --force-if-includes. The checks will re-run automatically.

_{Something broken? Consider reporting an issue.}
_{Running version 3eeda58 deployed on 2026-08-18 11:06:29 CEST}

openwrt-ai

The core premise checks out: frps.init reads the admin_* options exclusively (_emit_admin_web / _emit_admin_web_tls), the dashboard_* names appear only in frps.uci-defaults as one-shot migration sources, and frps.config ships the admin_* spelling — so the LuCI page really was writing dead options. The admin_tls_mode → admin_tls_enable mapping and the .toml include requirement both match the init script as well. Backend consumers verified against openwrt/packages@ff5519f.

Five inline notes: one blocking-ish bug on the TLS file fields (an invalid datatype that predates this PR but sits on lines being rewritten), one factual correction to a default value, and three nits.

Generated by Claude Code

openwrt-ai · 2026-08-27T19:43:24Z

+	[form.Value, 'admin_tls_cert_file', _('Dashboard TLS certificate'), _('Dashboard TLS certificate specifies the path to the TLS certificate file for enabling HTTPS access.<br />Required if HTTPS is enabled.'), {datatype: 'filepath'}],
+    [form.Value, 'admin_tls_key_file', _('Dashboard TLS private key'), _('Dashboard TLS private key specifies the path to the TLS private key file for enabling HTTPS access.<br />Required if HTTPS is enabled.'), {datatype: 'filepath'}],


filepath is not a registered LuCI datatype, so these two fields can never be saved. ValidatorFactory.compile() looks the token up in types and raises SyntaxError: Unhandled token "filepath" when it isn't a function — nothing in validation.js defines filepath. These are the only two occurrences of the token in the whole tree; the datatype LuCI provides for path strings is file.

The suggestion also converts the leading 4 spaces on the second line to a tab, matching every other entry in the array.

Suggested change

[form.Value, 'admin_tls_cert_file', _('Dashboard TLS certificate'), _('Dashboard TLS certificate specifies the path to the TLS certificate file for enabling HTTPS access. Required if HTTPS is enabled.'), {datatype: 'filepath'}],

[form.Value, 'admin_tls_key_file', _('Dashboard TLS private key'), _('Dashboard TLS private key specifies the path to the TLS private key file for enabling HTTPS access. Required if HTTPS is enabled.'), {datatype: 'filepath'}],

[form.Value, 'admin_tls_cert_file', _('Dashboard TLS certificate'), _('Dashboard TLS certificate specifies the path to the TLS certificate file for enabling HTTPS access. Required if HTTPS is enabled.'), {datatype: 'file'}],

[form.Value, 'admin_tls_key_file', _('Dashboard TLS private key'), _('Dashboard TLS private key specifies the path to the TLS private key file for enabling HTTPS access. Required if HTTPS is enabled.'), {datatype: 'file'}],

Generated by Claude Code

openwrt-ai · 2026-08-27T19:43:34Z

-	[form.Flag, 'dashboard_tls_mode', _('Dashboard TLS mode'), _('Enable or disable TLS encryption for the dashboard. When enabled, HTTPS is used for secure communication.'), {datatype: 'bool'}],
-	[form.Value, 'dashboard_tls_cert_file', _('Dashboard TLS certificate'), _('Dashboard TLS Cert File specifies the path to the TLS certificate file for enabling HTTPS access.<br />Required if HTTPS is enabled.'), {datatype: 'filepath'}],
-    [form.Value, 'dashboard_tls_key_file', _('Dashboard TLS private key'), _('Dashboard TLS Key File specifies the path to the TLS private key file for enabling HTTPS access.<br />Required if HTTPS is enabled.'), {datatype: 'filepath'}],
+	[form.Value, 'admin_addr', _('Dashboard address'), _('Dashboard address specifies the address that the dashboard binds to.<br />By default, this value is "0.0.0.0".'), {datatype: 'ipaddr'}],


The stated default is wrong for the init script this PR is aligning to. _emit_admin_web() falls back to 127.0.0.1, not 0.0.0.0, when admin_addr is unset: _toml_line webServer.addr "${addr:-127.0.0.1}" string at frps.init:452. The shipped frps.config also comments the option out as 127.0.0.1. The 0.0.0.0 figure was carried over from the old frp .ini DashboardAddr semantics.

Suggested change

[form.Value, 'admin_addr', _('Dashboard address'), _('Dashboard address specifies the address that the dashboard binds to. By default, this value is "0.0.0.0".'), {datatype: 'ipaddr'}],

[form.Value, 'admin_addr', _('Dashboard address'), _('Dashboard address specifies the address that the dashboard binds to. By default, this value is "127.0.0.1".'), {datatype: 'ipaddr'}],

Generated by Claude Code

openwrt-ai · 2026-08-27T19:43:42Z

@@ -25,13 +25,13 @@ const commonConf = [
 	[form.Value, 'vhost_http_port', _('Vhost HTTP port'), _('VhostHttpPort specifies the port that the server listens for HTTP Vhost requests. If this value is 0, the server will not listen for HTTP requests.<br />By default, this value is 0.'), {datatype: 'port'}],


nit: while auditing this page against frps.init, one more option in the same array has no backend consumer — bind_udp_port on line 21. Grepping the whole net/frp package for bind_udp_port / bindUdpPort / bindUDPPort returns nothing: _emit_common() emits bind_addr, bind_port, kcp_bind_port, quic_bind_port and no UDP bind port, and frps.config never mentions it. frp dropped bind_udp_port when it moved to TOML, so this field is silently ignored the same way the dashboard_* names were.

Was leaving it in place deliberate (out of scope for this commit), or should it be dropped here too?

Generated by Claude Code

openwrt-ai · 2026-08-27T19:43:51Z

-    [form.Value, 'dashboard_tls_key_file', _('Dashboard TLS private key'), _('Dashboard TLS Key File specifies the path to the TLS private key file for enabling HTTPS access.<br />Required if HTTPS is enabled.'), {datatype: 'filepath'}],
+	[form.Value, 'admin_addr', _('Dashboard address'), _('Dashboard address specifies the address that the dashboard binds to.<br />By default, this value is "0.0.0.0".'), {datatype: 'ipaddr'}],
+	[form.Value, 'admin_port', _('Dashboard port'), _('Dashboard port specifies the port that the dashboard listens on. If this value is 0, the dashboard will not be started.<br />By default, this value is 0.'), {datatype: 'port'}],
+	[form.Value, 'admin_user', _('Dashboard user'), _('Dashboard user specifies the username that the dashboard will use for login.<br />By default, this value is "admin".')],


nit: this description rewrite (DashboardUser specifies… → Dashboard user specifies…) is purely cosmetic — the UCI option rename is what fixes the bug, the help string is not read by anything. Changing the msgid invalidates the existing translations: 42 po/*/frps.po files carry these strings today (e.g. po/zh_Hans/frps.po has a filled-in msgstr for this one), and they all revert to English on merge. Same applies to the description-only edits on lines 29, 31, 33 and 34.

If the rewording is kept, it would be more useful to name the TOML key the init script actually generates (webServer.user here, webServer.addr / webServer.port / webServer.password above) rather than repeating the field label — that gives users something greppable against frps_full_example.toml.

Generated by Claude Code

openwrt-ai · 2026-08-27T19:44:01Z

 	[form.Flag, 'respawn', _('Respawn when crashed')],
 	[form.DynamicList, 'env', _('Environment variable'), _('OS environments pass to frp for config file template, see %s'.format(`<a href="https://github.com/fatedier/frp#configuration-file-template">frp README</a>`)), {placeholder: 'ENV_NAME=value'}],
-	[form.DynamicList, 'conf_inc', _('Additional configs'), _('Config files include in temporary config file'), {placeholder: '/etc/frp/frps.d/frps_full.ini'}]
+	[form.DynamicList, 'conf_inc', _('Additional configs'), _('Config files include in temporary config file'), {placeholder: '/etc/frp/frps.d/frps_full.toml'}]


nit: the .ini → .toml fix is correct here (_append_conf_file() rejects anything not ending in .toml under /etc/frp/frps.d/), but the sibling app has the identical stale placeholder — luci-app-frpc/htdocs/luci-static/resources/view/frpc.js:16 still suggests /etc/frp/frpc.d/frpc_full.ini, and frpc.init applies the same "$dir"*.toml guard. Worth fixing in the same series so the two pages stay in step.

(For what it's worth, luci-app-frpc already uses admin_addr/admin_port/admin_user/admin_pwd, so the rename in this PR brings frps into parity with frpc rather than diverging from it — the direction looks right.)

Generated by Claude Code

laipeng668 · 2026-08-28T07:08:01Z

Forget that one—try this one instead: #8674

luci-app-frps: align dashboard options with frps init script

6e01ced

openwrt Bot added the not following guidelines Pull request does not follow formatting guidelines label Aug 27, 2026

openwrt-ai reviewed Aug 27, 2026

View reviewed changes

Navigation Menu

Uh oh!

luci-app-frps: align dashboard options with frps init script - #8987

luci-app-frps: align dashboard options with frps init script#8987
frank-pv wants to merge 1 commit into
openwrt:masterfrom
frank-pv:master

frank-pv commented Aug 27, 2026

Uh oh!

openwrt Bot commented Aug 27, 2026

PR Targeting Violation

Uh oh!

openwrt-ai left a comment

Uh oh!

openwrt-ai Aug 27, 2026

Uh oh!

openwrt-ai Aug 27, 2026

Uh oh!

openwrt-ai Aug 27, 2026

Uh oh!

openwrt-ai Aug 27, 2026

Uh oh!

openwrt-ai Aug 27, 2026

Uh oh!

laipeng668 commented Aug 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		[form.Value, 'admin_tls_cert_file', _('Dashboard TLS certificate'), _('Dashboard TLS certificate specifies the path to the TLS certificate file for enabling HTTPS access.<br />Required if HTTPS is enabled.'), {datatype: 'filepath'}],
		[form.Value, 'admin_tls_key_file', _('Dashboard TLS private key'), _('Dashboard TLS private key specifies the path to the TLS private key file for enabling HTTPS access.<br />Required if HTTPS is enabled.'), {datatype: 'filepath'}],

	[form.Value, 'admin_addr', _('Dashboard address'), _('Dashboard address specifies the address that the dashboard binds to.<br />By default, this value is "0.0.0.0".'), {datatype: 'ipaddr'}],
	[form.Value, 'admin_addr', _('Dashboard address'), _('Dashboard address specifies the address that the dashboard binds to.<br />By default, this value is "127.0.0.1".'), {datatype: 'ipaddr'}],

		@@ -25,13 +25,13 @@ const commonConf = [
		[form.Value, 'vhost_http_port', _('Vhost HTTP port'), _('VhostHttpPort specifies the port that the server listens for HTTP Vhost requests. If this value is 0, the server will not listen for HTTP requests.<br />By default, this value is 0.'), {datatype: 'port'}],

Uh oh!

Conversation

frank-pv commented Aug 27, 2026

Pull request details

Description

Screenshot or video of changes

Maintainer

Tested on

Checklist

Uh oh!

openwrt Bot commented Aug 27, 2026

Formality Check: Failed

🛑 CRITICAL ERRORS

PR Targeting Violation

Uh oh!

openwrt-ai left a comment

Choose a reason for hiding this comment

Uh oh!

openwrt-ai Aug 27, 2026

Choose a reason for hiding this comment

Uh oh!

openwrt-ai Aug 27, 2026

Choose a reason for hiding this comment

Uh oh!

openwrt-ai Aug 27, 2026

Choose a reason for hiding this comment

Uh oh!

openwrt-ai Aug 27, 2026

Choose a reason for hiding this comment

Uh oh!

openwrt-ai Aug 27, 2026

Choose a reason for hiding this comment

Uh oh!

laipeng668 commented Aug 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants