跳到內容
Octoboard 說明文件

透過 Tailscale 用瀏覽器存取

透過你自己的 Tailscale 網路,在另一台電腦的瀏覽器中開啟 Octoboard,不需要 SSH 或遠端桌面。主機是執行 Octoboard 的那台電腦:Mac、Windows 電腦,或執行 octoboardd 的 Linux 伺服器。SSH 登入(macOS 上的「遠端登入」)可以保持關閉。

不確定該用哪種方式?請看選擇連線方式。

你電腦上的瀏覽器 → 你電腦上的轉送程式(127.0.0.1) ⟷ Tailscale ⟷ 主機上的轉送程式(127.0.0.1) → Octoboard

新手須知
  • Tailscale:一項透過網際網路把你的裝置連成私人網路的服務,不管裝置在哪裡都能用。你用自己的帳號登入它。
  • tailnet:你的 Tailscale 網路,也就是登入了你 Tailscale 帳號的那些裝置。
  • 127.0.0.1(回送位址):永遠代表「本機」的位址。
  • 連接埠:用來指定電腦上某個程式的編號,就像門牌號碼。127.0.0.1:3369 就是本機的 3369 連接埠。
  • socat:一個免費的小程式,負責把連線從一處轉到另一處。這裡用它當作轉送程式。
  • Tailscale Serve:Tailscale 的一個指令,只把連接埠分享給你的 tailnet。和它相近的 Tailscale Funnel 會把連接埠分享到整個網際網路,這裡千萬不要用。
  • 終端機:輸入指令的視窗,macOS 上是「終端機」,Windows 上是 PowerShell。

基於安全考量,Octoboard 只接受在 127.0.0.1(永遠代表「本機」的位址,也稱為回送位址)上開啟的瀏覽器頁面,所以不能直接在瀏覽器裡輸入主機的 Tailscale 位址。做法是在兩台電腦上各執行一個小型轉送程式:你這邊的讓主機看起來就在本機的 127.0.0.1 上,主機那邊的把連線交給 Octoboard,中間由 Tailscale 傳送。

  • 兩台電腦都安裝好 Tailscale,並登入同一個 tailnet。請使用只包含你自己裝置的 tailnet:其中每一台能連到主機的裝置,都能存取你分享的連接埠。

  • Mac 或執行 Linux 的電腦都要安裝 socat。Windows 電腦不需要。

    如果還沒有 Homebrew,請先安裝它(macOS 內建的工具都做不到這件事),然後在「終端機」中執行:

    Terminal window
    brew install socat
  • 使用期間要開著兩到三個視窗:主機上的轉送程式和 Tailscale Serve(Windows 主機不需要轉送程式),以及你電腦上的轉送程式(Windows 電腦不需要)。

  1. 取得瀏覽器位址,位址裡帶有登入金鑰,用瀏覽器開啟就能直接登入。

    在 Octoboard 中開啟設定 › 遠端存取,開啟允許遠端存取,再點選允許確認。開關下方會出現兩個分頁。在瀏覽器分頁的步驟 2:瀏覽器位址處,點選複製位址。

    請用只有你自己看得到的方式把位址傳到另一台電腦,例如傳給自己的筆記:它的作用就像密碼。

    跳過步驟 1:SSH 轉送。應用程式的設定裡有多處提到 SSH,這裡可以不用理會,本指南只會用到瀏覽器位址。

    請讓 Octoboard 保持執行,結束後遠端存取也會隨之中斷。

  2. 在主機上啟動轉送程式,把主機 127.0.0.1 上的一個連接埠接到 Octoboard。下文的主機連接埠就是這個連接埠。

    在「終端機」中執行這個指令,不要關閉視窗。它只監聽 127.0.0.1:3370。

    Terminal window
    socat TCP-LISTEN:3370,bind=127.0.0.1,reuseaddr,fork UNIX-CONNECT:"$HOME/.octoboard/browser.sock"

    主機連接埠是 3370。

  3. 用 Tailscale Serve 把主機連接埠分享給你的 tailnet,不要關閉視窗。不要使用 Tailscale Funnel,它會把連接埠公開到網際網路上。

    Terminal window
    tailscale serve --tcp=3370 tcp://127.0.0.1:3370

    如果用的是 App Store 版 Tailscale,請用 /Applications/Tailscale.app/Contents/MacOS/Tailscale 代替指令中的 tailscale。如果用的是獨立版,請先在它的設定中的 CLI integration 裡安裝指令。

    檢查方法:在另一個視窗執行 tailscale serve status,清單中應該會有主機連接埠。

  1. 在這台電腦的 Tailscale 應用程式中找到主機,記下它的名稱(例如 my-mac)或位址(形如 100.x.y.z 的數字)。

  2. 在這台電腦上啟動轉送程式,讓主機出現在本機的 127.0.0.1:3369 上。如果這台電腦上的 3369 連接埠已被占用,請換一個連接埠,並在瀏覽器位址中也改成它。

    把下面指令中的 <host> 換成主機的名稱或位址,<host port> 換成主機連接埠。

    Terminal window
    socat TCP-LISTEN:3369,bind=127.0.0.1,reuseaddr,fork TCP:<host>:<host port>

    例如主機是一台名為 my-mac 的 Mac:

    Terminal window
    socat TCP-LISTEN:3369,bind=127.0.0.1,reuseaddr,fork TCP:my-mac:3370

    在「終端機」中執行,不要關閉視窗。

  3. 開啟在主機上複製的瀏覽器位址。它以 http://127.0.0.1:3369/ 開頭。

看到 Octoboard 在瀏覽器分頁中開啟,而且沒有要求你登入,就表示成功了。

  • 頁面打不開:某個視窗被關掉了,或其中的指令已停止。請確認轉送程式和 Tailscale Serve 都還在執行,並且主機上的 tailscale serve status 有列出主機連接埠。
  • socat 提示「Address already in use」:這台電腦上的該連接埠已被占用。請換一個連接埠;如果是你這邊的電腦,瀏覽器位址裡也要改成它。
  • 頁面被拒絕或一片空白:請確認開啟的是 127.0.0.1 開頭的位址,而不是主機的 Tailscale 名稱或 100.x.y.z 位址。
  • 開啟頁面時,主機上的轉送程式提示「Connection refused」或「No such file or directory」:允許遠端存取沒有開啟,或主機上的 Octoboard 沒有在執行(Linux 上是 octoboardd 沒有在執行)。
  • 在用來瀏覽的電腦上:按 Ctrl+C 停止 socat;在 Windows 上,以系統管理員身分開啟 PowerShell,刪除轉送:

    Terminal window
    netsh interface portproxy delete v4tov4 listenaddress=127.0.0.1 listenport=3369
  • 在主機上:按 Ctrl+C 停止 Tailscale Serve 指令和 socat。用 tailscale serve status 確認已不再分享任何內容;如果連接埠仍在清單中,用 tailscale serve --tcp=3370 off 移除它(Windows 上用 tailscale serve --tcp=3369 off)。

  • 主機是 Mac 或 Windows 時,不再需要時請關閉允許遠端存取。這會關閉瀏覽器入口,並中斷所有用該金鑰開啟的頁面。

  • 如果位址可能已外洩,在瀏覽器分頁點選輪替金鑰為它換一把新金鑰,Linux 上則執行 octoboardd address --rotate。用舊位址開啟的頁面會被中斷。

  • 位址就是密碼:位址裡的金鑰可以完全控制主機上的 Octoboard,包括執行任何指令。金鑰在你輪替之前一直有效。它會留在瀏覽器的瀏覽紀錄和書籤裡,開啟同步後還會同步到你的其他裝置。
  • 誰能存取:能連到主機連接埠並持有金鑰的任何人。兩台電腦上的轉送程式只監聽 127.0.0.1,主機所在網路或你本地網路中的其他裝置都連不到;Tailscale Serve 只讓你的 tailnet 能連到主機連接埠,並受它的存取規則限制。
  • 只在沒有其他人登入的電腦上使用:主機或你電腦上的其他使用者帳戶可以連到這些 127.0.0.1 連接埠;轉送程式沒在執行時,他們還可以占用該連接埠,在你的瀏覽器重新連線時拿到金鑰。透過 SSH 連線時,Mac 或 Linux 主機沒有這個弱點;用桌面應用程式時,你自己的電腦也沒有。但用瀏覽器時,你用來瀏覽的電腦仍有這個弱點,因為那裡的 SSH 轉送同樣監聽 127.0.0.1 連接埠。
  • 不要使用 Funnel:Tailscale Funnel 會把連接埠公開到整個網際網路。