3x-ui regress

This commit is contained in:
2026-10-04 21:03:48 +03:00
parent b88c8ebce0
commit 99747849d3
2 changed files with 398 additions and 68 deletions
+197 -68
View File
@@ -47,6 +47,14 @@ let
# then SIGHUPs xray so clients can connect. Runs every 30s; safe to
# overlap with the panel's own config writes (it's idempotent and only
# touches missing/different fields).
#
# Both migrateScript (one-shot at container start) and patchScript +
# timer (every 10s) are commented out as of 2026-10-04: the user is
# switching the xray-core version through the panel UI instead of
# patching config.json from NixOS. See ./3x-ui-migration-notes.md for
# the full investigation, the panel bug reference, and how to re-enable
# the workarounds if a future panel build re-introduces the issue.
#
# REAL ROOT-CAUSE FIX for the 3x-ui config-gen bug.
#
# In `internal/web/service/xray.go` the panel's `GetXrayConfig()`
@@ -71,48 +79,132 @@ let
# The migration is idempotent (no-op once fields are top-level) and is
# re-applied on every container start so that any new inbound created
# via the panel UI gets migrated automatically.
migrateScript = pkgs.writeScript "migrate-3xui-reality.py" ''
#!/usr/bin/env python3
"""Move Reality fields from nested settings to top-level realitySettings in DB.
Idempotent. Re-applied on every container start so newly-added inbounds
are auto-migrated."""
import json, sqlite3, sys
FIELDS = ("publicKey", "fingerprint", "serverName", "spiderX", "mldsa65Verify")
try:
conn = sqlite3.connect("/etc/x-ui/x-ui.db")
rows = conn.execute(
"SELECT id, stream_settings FROM inbounds "
"WHERE stream_settings IS NOT NULL AND protocol='vless'"
).fetchall()
migrated = 0
for rid, ss_json in rows:
ss = json.loads(ss_json)
rs = ss.get("realitySettings")
if not rs:
continue
inner = rs.get("settings", {})
if not inner:
continue
changed = False
for k in FIELDS:
v = inner.get(k)
if v and not rs.get(k):
rs[k] = v
changed = True
if changed:
conn.execute(
"UPDATE inbounds SET stream_settings=? WHERE id=?",
(json.dumps(ss), rid),
)
migrated += 1
conn.commit()
conn.close()
print(f"migrated={migrated}")
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)
'';
#
# migrateScript = pkgs.writeScript "migrate-3xui-reality.py" ''
# #!/usr/bin/env python3
# """Move Reality fields from nested settings to top-level realitySettings in DB.
#
# Idempotent. Re-applied on every container start so newly-added inbounds
# are auto-migrated."""
# import json, sqlite3, sys
# FIELDS = ("publicKey", "fingerprint", "serverName", "spiderX", "mldsa65Verify")
# try:
# conn = sqlite3.connect("/etc/x-ui/x-ui.db")
# rows = conn.execute(
# "SELECT id, stream_settings FROM inbounds "
# "WHERE stream_settings IS NOT NULL AND protocol='vless'"
# ).fetchall()
# migrated = 0
# for rid, ss_json in rows:
# ss = json.loads(ss_json)
# rs = ss.get("realitySettings")
# if not rs:
# continue
# inner = rs.get("settings", {})
# if not inner:
# continue
# changed = False
# for k in FIELDS:
# v = inner.get(k)
# if v and not rs.get(k):
# rs[k] = v
# changed = True
# if changed:
# conn.execute(
# "UPDATE inbounds SET stream_settings=? WHERE id=?",
# (json.dumps(ss), rid),
# )
# migrated += 1
# conn.commit()
# conn.close()
# print(f"migrated={migrated}")
# except Exception as e:
# print(f"ERROR: {e}", file=sys.stderr)
# sys.exit(1)
# '';
# Patches /app/bin/config.json inside the running container so every reality
# inbound has top-level publicKey/fingerprint/serverName/spiderX/mldsa65Verify
# sourced from the panel's DB. The 3x-ui panel's GetXrayConfig (in
# internal/web/service/xray.go) explicitly drops the nested
# `realitySettings.settings` block before serialising bin/config.json
# (a bug in v3.8.5 and v3.9.0). After every panel regeneration (xray
# restart, inbound update, restartXray API call) xray is left without the
# public fields and REALITY auth fails for every inbound. Re-running the
# DB-only migration at container start is not enough: the panel overwrites
# stream_settings back to nested-only within seconds for active inbounds.
# We re-read the source-of-truth nested block from /etc/x-ui/x-ui.db and
# re-inject the missing top-level fields into the rendered config.json,
# then SIGHUP xray so it picks up the patch without dropping live
# connections. Idempotent. Runs every 10s via systemd timer; the
# migrateScript service covers first boot.
#
# patchScript = pkgs.writeScript "patch-3xui-xray-config.py" ''
# #!/usr/bin/env python3
# """Patch /app/bin/config.json so every reality inbound has the public fields
# xray needs to complete the REALITY handshake. Idempotent: no-op once
# top-level fields are present."""
# import json, os, signal, sqlite3, sys
# CFG = "/app/bin/config.json"
# FIELDS = ("publicKey", "fingerprint", "serverName", "spiderX", "mldsa65Verify")
# try:
# conn = sqlite3.connect("/etc/x-ui/x-ui.db")
# rows = conn.execute(
# "SELECT id, port, stream_settings FROM inbounds "
# "WHERE stream_settings IS NOT NULL AND protocol='vless'"
# ).fetchall()
# port_to_src = {}
# for _, port, ss_json in rows:
# ss = json.loads(ss_json)
# rs = ss.get("realitySettings") or {}
# inner = rs.get("settings") or {}
# src = {k: v for k in FIELDS if (v := rs.get(k) or inner.get(k))}
# if src:
# port_to_src[port] = src
# conn.close()
# if not port_to_src:
# print("no-source")
# sys.exit(0)
# with open(CFG) as f:
# cfg = json.load(f)
# patched = []
# for ib in cfg.get("inbounds", []):
# port = ib.get("port")
# src = port_to_src.get(port)
# if not src:
# continue
# ss = ib.setdefault("streamSettings", {})
# rs = ss.setdefault("realitySettings", {})
# ib_changed = False
# for k, v in src.items():
# if rs.get(k) != v:
# rs[k] = v
# ib_changed = True
# if ib_changed:
# patched.append(port)
# if not patched:
# print("clean")
# sys.exit(0)
# tmp = CFG + ".tmp"
# with open(tmp, "w") as f:
# json.dump(cfg, f, indent=2)
# os.replace(tmp, CFG)
# sent = 0
# for entry in os.listdir("/proc"):
# if not entry.isdigit():
# continue
# try:
# with open(f"/proc/{entry}/comm") as f:
# comm = f.read().strip()
# if comm.startswith("xray"):
# os.kill(int(entry), signal.SIGHUP)
# sent += 1
# except (FileNotFoundError, ProcessLookupError, ValueError):
# continue
# print(f"patched ports={patched} sighup={sent}")
# except Exception as e:
# print(f"ERROR: {e}", file=sys.stderr)
# sys.exit(1)
# '';
in
{
# `host."3x-ui"` options are declared in modules/options.nix: they are set
@@ -131,15 +223,16 @@ in
oci-containers = {
backend = "podman";
containers."3xui_app" = {
# Pinned to v3.8.5 — the last release before the panel added the
# nested `realitySettings.settings` block for new post-quantum
# fields that its own GetXrayConfig then strips on every regenerate.
# Both 3.8.5 and 3.9.0 reproduce the bug; we work around it with
# migrate-3xui-reality.service, which moves the affected fields
# to the top level of `realitySettings` in the DB so they survive
# the panel's delete() of the nested block. The migration runs
# once on every container start, idempotently.
image = "ghcr.io/mhsanaei/3x-ui:v3.8.5";
# Pinned to v3.9.0 (latest stable at 2026-10-03) as of the 2026-10-04
# clean regress. The xray-core version is no longer managed here —
# it is switched through the panel UI (Settings → Xray version),
# which writes to /app/bin/xray-linux-amd64 inside the container.
# The migrateScript + patchScript + service + timer workarounds for
# the panel's GetXrayConfig bug are commented out in this file;
# see ./3x-ui-migration-notes.md for the full investigation and
# how to re-enable them if a future panel build reintroduces the
# issue.
image = "ghcr.io/mhsanaei/3x-ui:v3.9.0";
environment = {
"XRAY_VMESS_AEAD_FORCED" = "false";
"XUI_ENABLE_FAIL2BAN" = "true";
@@ -187,31 +280,67 @@ containers."3xui_app" = {
# inside the container). Restart=on-failure so a transient container
# race (e.g. 3x-ui still seeding the DB on first start) is retried
# instead of silently passing.
"migrate-3xui-reality" = {
path = [ pkgs.podman ];
serviceConfig = {
Type = "oneshot";
RemainAfterExit = true;
Restart = "on-failure";
RestartSec = 5;
};
script = ''
${pkgs.podman}/bin/podman exec -i 3xui_app python3 < ${migrateScript}
'';
after = [ "podman-3xui_app.service" ];
wantedBy = [ "podman-compose-3x-ui-root.target" ];
};
#
# COMMENTED OUT 2026-10-04 — user switched to changing the xray-core
# version through the panel UI instead of patching config.json from
# NixOS. See ./3x-ui-migration-notes.md. To re-enable, uncomment
# this service AND the corresponding migrateScript in the `let`
# block above.
#
# "migrate-3xui-reality" = {
# path = [ pkgs.podman ];
# serviceConfig = {
# Type = "oneshot";
# RemainAfterExit = true;
# Restart = "on-failure";
# RestartSec = 5;
# };
# script = ''
# ${pkgs.podman}/bin/podman exec -i 3xui_app python3 < ${migrateScript}
# '';
# after = [ "podman-3xui_app.service" ];
# wantedBy = [ "podman-compose-3x-ui-root.target" ];
# };
# Continuous patch: every 10s the timer re-injects the public
# reality fields into /app/bin/config.json and SIGHUPs xray so the
# panel's GetXrayConfig bug cannot keep auth broken for more than
# one timer interval. The migrate-3xui-reality service above only
# covers first boot; the panel overwrites stream_settings back to
# nested-only within seconds, so a oneshot at container start is
# not enough.
#
# COMMENTED OUT 2026-10-04 — same reason as migrate-3xui-reality
# above. Uncomment this service, the corresponding patchScript in
# the `let` block, and the timer below to re-enable the per-10s
# patch loop. See ./3x-ui-migration-notes.md.
#
# "patch-3xui-xray-config" = {
# path = [ pkgs.podman ];
# serviceConfig = {
# Type = "oneshot";
# TimeoutSec = 30;
# };
# script = ''
# ${pkgs.podman}/bin/podman exec -i 3xui_app python3 < ${patchScript}
# '';
# };
};
# Starts/stops together with all 3x-ui compose resources.
targets."podman-compose-3x-ui-root" = {
unitConfig.Description = "Root target generated by compose2nix.";
wantedBy = [ "multi-user.target" ];
};
# timers."podman-update-3xui_app" = {
# COMMENTED OUT 2026-10-04 — see ./3x-ui-migration-notes.md and the
# commented-out patch-3xui-xray-config service above. Uncomment to
# re-enable the per-10s config.json patch loop.
#
# timers."patch-3xui-xray-config" = {
# wantedBy = [ "timers.target" ];
# timerConfig = {
# OnCalendar = "weekly";
# Persistent = true;
# OnBootSec = "20s";
# OnUnitActiveSec = "10s";
# Persistent = false;
# Unit = "patch-3xui-xray-config.service";
# };
# };
tmpfiles.rules = [