Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#4,042 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
88/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
shell
Lĩnh vực
devops

Hướng nghiên cứu

Bắt đầu trong install.sh bằng cách kiểm tra phần kiểm tra trạng thái sẵn sàng và các đường dẫn dọn dẹp hiện đang sử dụng thư mục cấu hình gateway cục bộ. Chạy mise run test:install-sh, bao quát các giá trị XDG_CONFIG_HOME chưa được đặt, rỗng, đã được đặt và đã được đặt với khoảng trắng. Hoàn thành khi installer và CLI sử dụng cùng một thư mục, các kịch bản cài đặt lại được liệt kê thoát với mã thoát 0 và các kiểm tra chấp nhận đều đạt.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Rust
Star
13.2k
Fork
1.6k
Merge trung bình
1 ngày 21 giờ
Pull request đã merge (30 ngày)
346

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của NVIDIA/OpenShell

Tất cả issue của NVIDIA/OpenShell

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.