安裝 Hostel CLI 並連線
hostel 二進位檔對於人員、代理、伺服器以及房間機器都是相同的。這項技能可將它安裝在人員的電腦上,並將該電腦連接到伺服器。如需伺服器機器,請參閱 hostel-server-setup。如需房間機器,請參閱 hostel-rooms。
macOS 與 Linux
curl -fsSL https://raw.githubusercontent.com/csansoon/hostel/main/install.sh | sh
該腳本會下載最新的 GitHub 發行版,根據發行版的 SHA256SUMS 檢查檔案,並將 hostel 安裝到 ~/.local/bin。
選項(將它們放在 sh -s -- 之後):
| 選項 | 效果 |
|---|---|
--dir DIR | 將二進位檔安裝到 DIR(預設為 ~/.local/bin)。 |
--version vX.Y.Z | 安裝此發行版(預設為最新版)。 |
--server DIR | 同時將房間二進位檔安裝到 DIR/helpers,並將平台腳本安裝到 DIR/platforms。僅適用於伺服器機器。 |
範例:
curl -fsSL https://raw.githubusercontent.com/csansoon/hostel/main/install.sh | sh -s -- --dir /usr/local/bin
curl -fsSL https://raw.githubusercontent.com/csansoon/hostel/main/install.sh | sh -s -- --version v0.1.0
如果腳本顯示 note: ... is not on your PATH,請在 shell profile 中將該目錄加入 PATH,例如:
export PATH="$HOME/.local/bin:$PATH"
支援平台:amd64 或 arm64 架構的 macOS 與 Linux。環境變數 HOSTEL_INSTALL_URL 可取代下載網址(可用於鏡像站)。
Windows
在 PowerShell 中(不需管理員權限):
irm https://raw.githubusercontent.com/csansoon/hostel/main/install.ps1 | iex
該腳本會將 hostel.exe 安裝到 %LOCALAPPDATA%\Programs\hostel,根據 SHA256SUMS 進行檢查,並將該目錄加入使用者 PATH。首次安裝後請開啟新的終端機。$env:HOSTEL_VERSION(例如 v0.1.0)可選擇發行版本;$env:HOSTEL_INSTALL_URL 可設定鏡像站。
注意:install.ps1 是新的安裝方式。如果失敗,請從 GitHub 發行版下載 hostel-windows-amd64.exe(或 -arm64.exe),重新命名為 hostel.exe,並放入 PATH 中的某個目錄。
檢查安裝
hostel --version
hostel help
將電腦連接到伺服器
伺服器的管理員會給您一個邀請碼(hostel1-...)。此碼僅能使用一次,有效期為 24 小時。管理員如何產生邀請碼請參閱 hostel-users。
hostel connect hostel1-...
hostel connect hostel1-... --name "Alice Example"
- 預設名稱來自
git config user.name。在終端機中,connect會要求輸入名稱。 - 輸出會顯示伺服器、固定的 TLS 金鑰(適用於擁有自己憑證的伺服器)、您的角色以及電腦名稱。
- 連線資訊會儲存到
~/.config/hostel/config.toml(權限 0600)。在 Windows 上,位於%USERPROFILE%下的相同位置。 - 一台電腦最多只能有一個連線。如果已有連線,
connect會在取代前詢問確認。使用--yes可直接取代,不需詢問。 - 此電腦上的代理會使用相同的連線,不需要自己的連線。
檢查連線:
hostel status
中斷連線(伺服器會刪除這台電腦的令牌):
hostel disconnect
用於測試與 CI 時,環境變數 HOSTEL_SERVER、HOSTEL_TOKEN 和 HOSTEL_SERVER_KEY 可覆蓋設定檔。
Hostel 應用程式
在終端機中執行不帶參數的 hostel,即會開啟全螢幕應用程式:
- 未連線:Check in(貼上邀請碼,然後輸入您的名稱)或 Leave。
- Lobby:平台、其空閒機器、佇列以及等待狀態。
- Rooms:機器、其狀態以及使用中的人員。
- Front desk:伺服器與您;Invite a guest(管理員)、Add your other computer(成員)、Guest list、Add a room(管理員)、Check out(中斷連線)。
按鍵:1 2 3 可前往 Lobby、Rooms、Front desk;? 列出所有按鍵;q 退出。NO_COLOR=1 關閉顏色。如果沒有終端機(例如代理或管道),hostel 會改為顯示說明。代理請使用 hostel status(純文字)。
更新
再次執行相同的安裝指令。它會取代原有的二進位檔。
curl -fsSL https://raw.githubusercontent.com/csansoon/hostel/main/install.sh | sh
hostel --version
在 Windows 上,再次執行 irm ... | iex 即可。連線資訊會保留。
如果是伺服器機器,更新後請重新啟動服務(請參閱 hostel-server-setup 中的「更新」章節)。
下一步
- 使用房間:
hostel-use。 - 發生問題:
hostel-troubleshoot。