Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

bug: install.sh ignores XDG_CONFIG_HOME for the local gateway config

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#4,042 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@fede-kamel arbeitet bereits daran.

Seit 01.10.2026.

  • #4043 von @efegokdemir — ohne Merge geschlossen
  • #4063 von @fede-kamel — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
88/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
shell
Bereich
devops

Rechercherichtung

Beginne in install.sh mit der Untersuchung der Bereitschaftsprüfung und der Bereinigungspfade, die derzeit das lokale Gateway-Konfigurationsverzeichnis verwenden. Führe mise run test:install-sh aus und decke dabei nicht gesetzte, leere, gesetzte und gesetzte XDG_CONFIG_HOME-Werte mit Leerzeichen ab. Erledigt ist die Aufgabe, wenn Installer und CLI dasselbe Verzeichnis verwenden, die aufgeführten Neuinstallationsszenarien mit Exit-Code 0 beendet werden und die Akzeptanzprüfungen bestehen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

area:cli os:linux os:macos state:validated
User Story

As someone whose shell exports XDG_CONFIG_HOME,
I want install.sh to use the same config directory as the openshell CLI,
so that installing and reinstalling OpenShell just work.

Problem Statement

The CLI keeps each gateway's entry and client certificates under $XDG_CONFIG_HOME/openshell when that variable is set. The installer always uses ~/.config/openshell instead, in two places:

  • The readiness check, which connects to the gateway with the client certificates it expects to find there.
  • The cleanup that removes an old openshell entry before adding it again.

With the variable set, the installer and the CLI look in different directories.

Impact / Why This Matters

With XDG_CONFIG_HOME pointing somewhere other than ~/.config:

  • On macOS, the install fails whenever ~/.config/openshell has no client certificates for the gateway, or has old ones. The installer waits 30s and exits 1.
  • On macOS and Linux, running the installer a second time exits 1 with "Gateway 'openshell' already exists". When the gateway is already registered, the installer removes the entry and adds it again. But it removes it from ~/.config/openshell, and the CLI's entry is under $XDG_CONFIG_HOME/openshell. That entry is still there, so adding it again fails.

The gateway itself keeps running in both cases. On Linux the first run works only because the gateway service also writes a copy of its client certificates to ~/.config/openshell when it starts, so the readiness check happens to find current ones there.

The workarounds don't really work. Unsetting XDG_CONFIG_HOME just for the install puts the gateway entry under ~/.config, so the CLI in your normal shell can't find it afterwards. Running openshell gateway remove openshell before a reinstall avoids the "already exists" error, but not the certificate check on macOS. And nothing in the installer's output mentions the variable.

Acceptance Criteria

With XDG_CONFIG_HOME set and XDG_STATE_HOME unset:

  • The installer exits 0 when ~/.config/openshell has no client certificates for the gateway, and when it has old ones.
  • After the install, openshell status in the same shell shows the gateway.
  • Running the installer a second time exits 0.

In general:

  • With XDG_CONFIG_HOME unset or empty, the installer keeps using ~/.config/openshell.
  • mise run test:install-sh covers unset, empty, set, and set-with-spaces values.

With both XDG_CONFIG_HOME and XDG_STATE_HOME set, the Linux install fails for a different reason, that maybe is not as important, and not described in this issue.

Reproduction Steps
  1. export XDG_CONFIG_HOME="$(mktemp -d)", and make sure ~/.config/openshell/gateways/openshell doesn't exist.
  2. Run curl -LsSf https://raw.githubusercontent.com/NVIDIA/OpenShell/main/install.sh | sh.
  3. On macOS it waits 30s, prints mTLS client bundle is not ready under ~/.config/..., and exits 1. On Linux it succeeds.
  4. Run it again. Both platforms stop with Gateway 'openshell' already exists.
Environment
  • OpenShell 0.1.2, installer from main at 9cb72baa2. The installer code involved is the same on current main.
  • macOS 26.2 arm64, Homebrew 7.0.7, run as the logged-in user
  • Ubuntu 26.04 x86_64, deb package, run as root, Docker 29.1.3
Logs
# macOS, no certificates under ~/.config
mTLS client bundle is not ready under ~/.config/openshell/gateways/openshell/mtls
openshell: error: local gateway listener did not become reachable at https://localhost:17670/ within 30s

# macOS, old certificates under ~/.config
curl: (60) SSL certificate problem: unable to get local issuer certificate

# macOS and Linux, second run
openshell: local gateway already exists; removing and re-adding it...
Error:   × Gateway 'openshell' already exists.
Vorherrschende Sprache
Rust
Sterne
15.4k
Forks
1.7k
Ø Merge
2 T. 22 Min.
Gemergte PRs (30 T.)
352

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus NVIDIA/OpenShell

Alle Issues in NVIDIA/OpenShell

Ähnliche Issues

Weitere Issues zu Rust

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.