Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#4,042 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@fede-kamel ya está trabajando en esto.

Desde el 1/10/2026.

  • #4043 de @efegokdemir — cerrado sin fusionar
  • #4063 de @fede-kamel — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
88/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
shell
Área
devops

Línea de trabajo

Comienza en install.sh inspeccionando la comprobación de preparación y las rutas de limpieza que actualmente usan el directorio de configuración de la puerta de enlace local. Ejecuta mise run test:install-sh, cubriendo los valores de XDG_CONFIG_HOME no establecido, vacío, establecido y establecido con espacios. Se considera terminado cuando el instalador y la CLI usan el mismo directorio, los escenarios de reinstalación indicados terminan con código de salida 0 y las comprobaciones de aceptación pasan.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Rust
Estrellas
13.2k
Forks
1.6k
Merge medio
1 d 19 h
PR fusionados (30 d)
330

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NVIDIA/OpenShell

Todos los issues de NVIDIA/OpenShell

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.