From 0f6602aabdd04844698c47e8f7240cddbc875ac5 Mon Sep 17 00:00:00 2001 From: Bohdan Triapitsyn Date: Fri, 5 Jun 2026 18:38:39 +0300 Subject: [PATCH] docs: add SSH hosts and proxying guide Adds desktop SSH hosts and proxying documentation Includes translations for all supported locales Requires translations for new docs pages --- packages/docs/CONTRIBUTING.md | 11 ++--- .../content/docs/es/ssh-hosts-proxying.mdx | 48 +++++++++++++++++++ .../content/docs/ko/ssh-hosts-proxying.mdx | 48 +++++++++++++++++++ .../content/docs/pl/ssh-hosts-proxying.mdx | 48 +++++++++++++++++++ .../content/docs/pt-br/ssh-hosts-proxying.mdx | 48 +++++++++++++++++++ .../docs/content/docs/ssh-hosts-proxying.mdx | 48 +++++++++++++++++++ .../content/docs/uk/ssh-hosts-proxying.mdx | 48 +++++++++++++++++++ .../content/docs/zh-cn/ssh-hosts-proxying.mdx | 48 +++++++++++++++++++ packages/docs/sidebar.config.json | 12 +++++ 9 files changed, 353 insertions(+), 6 deletions(-) create mode 100644 packages/docs/content/docs/es/ssh-hosts-proxying.mdx create mode 100644 packages/docs/content/docs/ko/ssh-hosts-proxying.mdx create mode 100644 packages/docs/content/docs/pl/ssh-hosts-proxying.mdx create mode 100644 packages/docs/content/docs/pt-br/ssh-hosts-proxying.mdx create mode 100644 packages/docs/content/docs/ssh-hosts-proxying.mdx create mode 100644 packages/docs/content/docs/uk/ssh-hosts-proxying.mdx create mode 100644 packages/docs/content/docs/zh-cn/ssh-hosts-proxying.mdx diff --git a/packages/docs/CONTRIBUTING.md b/packages/docs/CONTRIBUTING.md index 8a0bcc9d..0e8d981d 100644 --- a/packages/docs/CONTRIBUTING.md +++ b/packages/docs/CONTRIBUTING.md @@ -98,9 +98,8 @@ running. - `foo.mdx` -> `/foo/` - `folder/index.mdx` -> `/folder/` - `folder/bar.mdx` -> `/folder/bar/` -4. Add translations for the page — see [Localization](#localization). Translations - are optional per page (a missing translation falls back to English), but ship - them together with the page when you can. +4. Add translations for the page — see [Localization](#localization). New pages + must include translated files for every supported locale before they ship. 5. If the page is linked from the sidebar, add its localized labels too — see [Translate the sidebar](#translate-the-sidebar). 6. Run validation: @@ -244,9 +243,9 @@ description: Встановіть OpenChamber для десктопа, вебу --- ``` -You do **not** have to translate every page at once. A page that is missing in a -locale automatically falls back to the English version, so translations can land -incrementally. +Every new page must include translated files for all supported locales before it +ships. Starlight can fall back to English when a translation is missing, but do +not rely on that fallback for new docs pages. ### Translate the sidebar diff --git a/packages/docs/content/docs/es/ssh-hosts-proxying.mdx b/packages/docs/content/docs/es/ssh-hosts-proxying.mdx new file mode 100644 index 00000000..1c2c1245 --- /dev/null +++ b/packages/docs/content/docs/es/ssh-hosts-proxying.mdx @@ -0,0 +1,48 @@ +--- +title: Hosts SSH y proxy +description: Importa hosts SSH guardados y agrega reenvíos de puertos SSH extra en la app de escritorio. +--- + +# Hosts SSH y proxy + +Usa **Settings → Remote Instances** en la app de escritorio para importar hosts SSH guardados, conectarte a una máquina remota y hacer que otros puertos estén disponibles por la misma conexión SSH. + +> Los hosts SSH y el proxy por SSH son funciones **solo de escritorio**. Usan el cliente SSH de tu computadora. + +## Importa un host SSH + +OpenChamber puede leer hosts desde tu SSH config local, el mismo lugar que usan comandos como `ssh work-server`. + +1. Abre **Settings → Remote Instances**. +2. Elige un host en **Saved SSH hosts**. +3. Si el host es un patrón, escribe el destino real, como `deploy@app.example.com`. +4. Guarda y conecta. + +OpenChamber crea una remote instance con ese comando SSH. Cuando llega a **ready**, la UI remota de OpenChamber se abre en la app de escritorio. + +## Agrega reenvíos de puertos extra + +Cada remote instance tiene una sección **Port Forwards**. Úsala cuando algo en un lado de la conexión SSH necesita llegar a un puerto del otro lado. + +OpenChamber soporta tres tipos de reenvío: + +- **Local (-L)** — abre un puerto en tu computadora que conecta con algo en la máquina remota. +- **Remote (-R)** — abre un puerto en la máquina remota que conecta de vuelta con tu computadora. +- **Dynamic (-D)** — abre un SOCKS proxy local por la conexión SSH. + +Para la mayoría de previews de apps y dashboards que corren en la máquina remota, usa **Local (-L)**. + +## Usa el SOCKS proxy + +Elige **Dynamic (-D)** cuando quieras que otras herramientas de tu computadora naveguen a través de la máquina remota. OpenChamber abre un puerto SOCKS proxy local para esa conexión SSH. + +Cuando la conexión esté ready, copia o usa la dirección proxy local desde la fila del reenvío. Configura tu navegador o herramienta para usarla como SOCKS5 proxy. + +## Manténlo privado + +Usa `127.0.0.1` o `localhost` como local bind host, salvo que quieras que otros dispositivos de tu red lleguen al puerto reenviado. + +## Relacionado + +- [Instancias remotas](/es/remote-instances/) — conecta la app de escritorio a OpenChamber en otra máquina +- [Acceso remoto](/es/troubleshooting/remote-access/) — cuando SSH o el acceso remoto no conectan diff --git a/packages/docs/content/docs/ko/ssh-hosts-proxying.mdx b/packages/docs/content/docs/ko/ssh-hosts-proxying.mdx new file mode 100644 index 00000000..8c00d397 --- /dev/null +++ b/packages/docs/content/docs/ko/ssh-hosts-proxying.mdx @@ -0,0 +1,48 @@ +--- +title: SSH 호스트 및 프록시 +description: 데스크톱 앱에서 저장된 SSH 호스트를 가져오고 추가 SSH 포트 포워딩을 설정하세요. +--- + +# SSH 호스트 및 프록시 + +데스크톱 앱의 **Settings → Remote Instances**에서 저장된 SSH 호스트를 가져오고, 원격 컴퓨터에 연결하고, 같은 SSH 연결을 통해 추가 포트를 사용할 수 있습니다. + +> SSH 호스트와 SSH 프록시는 **데스크톱 전용** 기능입니다. 사용자의 컴퓨터에 있는 SSH 클라이언트를 사용합니다. + +## SSH 호스트 가져오기 + +OpenChamber는 로컬 SSH config의 호스트를 읽을 수 있습니다. `ssh work-server` 같은 명령이 사용하는 같은 위치입니다. + +1. **Settings → Remote Instances**를 엽니다. +2. **Saved SSH hosts**에서 호스트를 선택합니다. +3. 호스트가 패턴이면 `deploy@app.example.com` 같은 실제 대상을 입력합니다. +4. 저장하고 연결합니다. + +OpenChamber는 이 SSH 명령으로 remote instance를 만듭니다. 상태가 **ready**가 되면 원격 OpenChamber UI가 데스크톱 앱에서 열립니다. + +## 추가 포트 포워딩 추가 + +각 remote instance에는 **Port Forwards** 섹션이 있습니다. SSH 연결의 한쪽에서 다른 쪽의 포트에 접근해야 할 때 사용하세요. + +OpenChamber는 세 가지 포워딩 유형을 지원합니다: + +- **Local (-L)** — 내 컴퓨터에 포트를 열고 원격 컴퓨터의 대상에 연결합니다. +- **Remote (-R)** — 원격 컴퓨터에 포트를 열고 내 컴퓨터로 다시 연결합니다. +- **Dynamic (-D)** — SSH 연결을 통해 로컬 SOCKS proxy를 엽니다. + +원격 컴퓨터에서 실행 중인 대부분의 앱 preview와 dashboard에는 **Local (-L)**을 사용하세요. + +## SOCKS proxy 사용 + +내 컴퓨터의 다른 도구가 원격 컴퓨터를 통해 접속하게 하려면 **Dynamic (-D)**을 선택하세요. OpenChamber는 해당 SSH 연결에 로컬 SOCKS proxy 포트를 엽니다. + +연결이 ready가 되면 포워딩 행에서 로컬 proxy 주소를 복사하거나 사용합니다. 브라우저나 도구에서 이 주소를 SOCKS5 proxy로 설정하세요. + +## 비공개로 유지 + +네트워크의 다른 기기가 포워딩된 포트에 접근해야 하는 경우가 아니라면 local bind host에는 `127.0.0.1` 또는 `localhost`를 사용하세요. + +## 관련 문서 + +- [원격 인스턴스](/ko/remote-instances/) — 데스크톱 앱을 다른 컴퓨터의 OpenChamber에 연결하세요 +- [원격 접속](/ko/troubleshooting/remote-access/) — SSH 또는 원격 접속이 연결되지 않을 때 diff --git a/packages/docs/content/docs/pl/ssh-hosts-proxying.mdx b/packages/docs/content/docs/pl/ssh-hosts-proxying.mdx new file mode 100644 index 00000000..6ec16bf2 --- /dev/null +++ b/packages/docs/content/docs/pl/ssh-hosts-proxying.mdx @@ -0,0 +1,48 @@ +--- +title: Hosty SSH i proxy +description: Importuj zapisane hosty SSH i dodawaj dodatkowe przekierowania portów SSH w aplikacji desktopowej. +--- + +# Hosty SSH i proxy + +Użyj **Settings → Remote Instances** w aplikacji desktopowej, aby importować zapisane hosty SSH, łączyć się ze zdalną maszyną i udostępniać dodatkowe porty przez to samo połączenie SSH. + +> Hosty SSH i proxy przez SSH to funkcje **tylko dla desktopu**. Używają klienta SSH na Twoim komputerze. + +## Importuj host SSH + +OpenChamber może czytać hosty z lokalnego SSH config, czyli z tego samego miejsca, którego używają polecenia takie jak `ssh work-server`. + +1. Otwórz **Settings → Remote Instances**. +2. Wybierz host z **Saved SSH hosts**. +3. Jeśli host jest wzorcem, wpisz prawdziwy cel, na przykład `deploy@app.example.com`. +4. Zapisz i połącz. + +OpenChamber tworzy remote instance z tym poleceniem SSH. Gdy osiągnie stan **ready**, zdalny UI OpenChamber otworzy się w aplikacji desktopowej. + +## Dodaj dodatkowe przekierowania portów + +Każda remote instance ma sekcję **Port Forwards**. Użyj jej, gdy coś po jednej stronie połączenia SSH musi dotrzeć do portu po drugiej stronie. + +OpenChamber obsługuje trzy typy przekierowań: + +- **Local (-L)** — otwiera port na Twoim komputerze, który łączy się z czymś na zdalnej maszynie. +- **Remote (-R)** — otwiera port na zdalnej maszynie, który łączy się z powrotem z Twoim komputerem. +- **Dynamic (-D)** — otwiera lokalny SOCKS proxy przez połączenie SSH. + +Dla większości preview aplikacji i dashboardów uruchomionych na zdalnej maszynie użyj **Local (-L)**. + +## Użyj SOCKS proxy + +Wybierz **Dynamic (-D)**, gdy chcesz, aby inne narzędzia na Twoim komputerze działały przez zdalną maszynę. OpenChamber otwiera lokalny port SOCKS proxy dla tego połączenia SSH. + +Gdy połączenie będzie ready, skopiuj albo użyj lokalnego adresu proxy z wiersza przekierowania. Skonfiguruj przeglądarkę lub narzędzie, aby używało go jako SOCKS5 proxy. + +## Zachowaj prywatność + +Używaj `127.0.0.1` albo `localhost` jako local bind host, chyba że celowo chcesz, aby inne urządzenia w Twojej sieci miały dostęp do przekierowanego portu. + +## Powiązane + +- [Zdalne instancje](/pl/remote-instances/) — połącz aplikację desktopową z OpenChamber na innej maszynie +- [Dostęp zdalny](/pl/troubleshooting/remote-access/) — gdy SSH lub zdalny dostęp się nie łączy diff --git a/packages/docs/content/docs/pt-br/ssh-hosts-proxying.mdx b/packages/docs/content/docs/pt-br/ssh-hosts-proxying.mdx new file mode 100644 index 00000000..9780cf2a --- /dev/null +++ b/packages/docs/content/docs/pt-br/ssh-hosts-proxying.mdx @@ -0,0 +1,48 @@ +--- +title: Hosts SSH e proxy +description: Importe hosts SSH salvos e adicione encaminhamentos de porta SSH extras no app desktop. +--- + +# Hosts SSH e proxy + +Use **Settings → Remote Instances** no app desktop para importar hosts SSH salvos, conectar a uma máquina remota e disponibilizar portas extras pela mesma conexão SSH. + +> Hosts SSH e proxy por SSH são recursos **apenas do desktop**. Eles usam o cliente SSH do seu computador. + +## Importe um host SSH + +O OpenChamber pode ler hosts do seu SSH config local, o mesmo lugar usado por comandos como `ssh work-server`. + +1. Abra **Settings → Remote Instances**. +2. Escolha um host em **Saved SSH hosts**. +3. Se o host for um pattern, informe o destino real, como `deploy@app.example.com`. +4. Salve e conecte. + +O OpenChamber cria uma remote instance com esse comando SSH. Quando ela chega em **ready**, a UI remota do OpenChamber abre no app desktop. + +## Adicione encaminhamentos de porta extras + +Cada remote instance tem uma seção **Port Forwards**. Use quando algo de um lado da conexão SSH precisa acessar uma porta do outro lado. + +O OpenChamber suporta três tipos de encaminhamento: + +- **Local (-L)** — abre uma porta no seu computador que conecta a algo na máquina remota. +- **Remote (-R)** — abre uma porta na máquina remota que conecta de volta ao seu computador. +- **Dynamic (-D)** — abre um SOCKS proxy local pela conexão SSH. + +Para a maioria dos previews de apps e dashboards rodando na máquina remota, use **Local (-L)**. + +## Use o SOCKS proxy + +Escolha **Dynamic (-D)** quando quiser que outras ferramentas no seu computador naveguem pela máquina remota. O OpenChamber abre uma porta local de SOCKS proxy para essa conexão SSH. + +Quando a conexão estiver ready, copie ou use o endereço proxy local na linha do encaminhamento. Configure seu navegador ou ferramenta para usá-lo como SOCKS5 proxy. + +## Mantenha privado + +Use `127.0.0.1` ou `localhost` como local bind host, a menos que você queira que outros dispositivos na sua rede acessem a porta encaminhada. + +## Relacionado + +- [Instâncias remotas](/pt-br/remote-instances/) — conecte o app desktop ao OpenChamber em outra máquina +- [Acesso remoto](/pt-br/troubleshooting/remote-access/) — quando SSH ou acesso remoto não conectam diff --git a/packages/docs/content/docs/ssh-hosts-proxying.mdx b/packages/docs/content/docs/ssh-hosts-proxying.mdx new file mode 100644 index 00000000..2014fdba --- /dev/null +++ b/packages/docs/content/docs/ssh-hosts-proxying.mdx @@ -0,0 +1,48 @@ +--- +title: SSH Hosts & Proxying +description: Import saved SSH hosts and add extra SSH port forwards in the desktop app. +--- + +# SSH Hosts & Proxying + +Use **Settings → Remote Instances** in the desktop app to import saved SSH hosts, connect to a remote machine, and make extra ports available through the same SSH connection. + +> SSH hosts and SSH proxying are **desktop-only** features. They use the SSH client on your computer. + +## Import an SSH host + +OpenChamber can read hosts from your local SSH config, the same place used by commands like `ssh work-server`. + +1. Open **Settings → Remote Instances**. +2. Choose a host from **Saved SSH hosts**. +3. If the host is a pattern, enter the real destination, such as `deploy@app.example.com`. +4. Save and connect. + +OpenChamber creates a remote instance using that SSH command. When it reaches **ready**, the remote OpenChamber UI opens in the desktop app. + +## Add extra port forwards + +Each remote instance has a **Port Forwards** section. Use it when something on one side of the SSH connection needs to reach a port on the other side. + +OpenChamber supports three forward types: + +- **Local (-L)** — open a port on your computer that connects to something on the remote machine. +- **Remote (-R)** — open a port on the remote machine that connects back to your computer. +- **Dynamic (-D)** — open a local SOCKS proxy through the SSH connection. + +For most app previews and dashboards running on the remote machine, use **Local (-L)**. + +## Use the SOCKS proxy + +Choose **Dynamic (-D)** when you want other tools on your computer to browse through the remote machine. OpenChamber opens a local SOCKS proxy port for that SSH connection. + +After the connection is ready, copy or use the local proxy address from the forward row. Configure your browser or tool to use it as a SOCKS5 proxy. + +## Keep it private + +Use `127.0.0.1` or `localhost` for local bind hosts unless you intentionally want other devices on your network to reach the forwarded port. + +## Related + +- [Remote Instances](/remote-instances/) — connect the desktop app to OpenChamber on another machine +- [Remote access](/troubleshooting/remote-access/) — when SSH or remote access does not connect diff --git a/packages/docs/content/docs/uk/ssh-hosts-proxying.mdx b/packages/docs/content/docs/uk/ssh-hosts-proxying.mdx new file mode 100644 index 00000000..be350403 --- /dev/null +++ b/packages/docs/content/docs/uk/ssh-hosts-proxying.mdx @@ -0,0 +1,48 @@ +--- +title: SSH-хости та проксі +description: Імпортуйте збережені SSH-хости й додавайте додаткові SSH-перенаправлення портів у десктопному застосунку. +--- + +# SSH-хости та проксі + +Використовуйте **Settings → Remote Instances** у десктопному застосунку, щоб імпортувати збережені SSH-хости, підключатися до віддаленої машини й відкривати додаткові порти через те саме SSH-з'єднання. + +> SSH-хости та SSH-проксі — це функції **лише для десктопа**. Вони використовують SSH-клієнт на вашому комп'ютері. + +## Імпортуйте SSH-хост + +OpenChamber може читати хости з вашого локального SSH config — того самого місця, яке використовують команди на кшталт `ssh work-server`. + +1. Відкрийте **Settings → Remote Instances**. +2. Виберіть хост у **Saved SSH hosts**. +3. Якщо хост є шаблоном, введіть реальне призначення, наприклад `deploy@app.example.com`. +4. Збережіть і підключіться. + +OpenChamber створить remote instance з цією SSH-командою. Коли стан стане **ready**, віддалений UI OpenChamber відкриється в десктопному застосунку. + +## Додайте перенаправлення портів + +Кожен remote instance має секцію **Port Forwards**. Використовуйте її, коли щось з одного боку SSH-з'єднання має дістатися порту з іншого боку. + +OpenChamber підтримує три типи перенаправлення: + +- **Local (-L)** — відкриває порт на вашому комп'ютері, який підключається до чогось на віддаленій машині. +- **Remote (-R)** — відкриває порт на віддаленій машині, який підключається назад до вашого комп'ютера. +- **Dynamic (-D)** — відкриває локальний SOCKS proxy через SSH-з'єднання. + +Для більшості preview застосунків і dashboard, що працюють на віддаленій машині, використовуйте **Local (-L)**. + +## Використовуйте SOCKS proxy + +Виберіть **Dynamic (-D)**, якщо хочете, щоб інші інструменти на вашому комп'ютері працювали через віддалену машину. OpenChamber відкриє локальний порт SOCKS proxy для цього SSH-з'єднання. + +Коли з'єднання готове, скопіюйте або використайте локальну proxy-адресу з рядка перенаправлення. Налаштуйте браузер або інструмент на використання її як SOCKS5 proxy. + +## Тримайте доступ приватним + +Використовуйте `127.0.0.1` або `localhost` для local bind host, якщо ви навмисно не хочете, щоб інші пристрої у вашій мережі діставалися перенаправленого порту. + +## Пов'язане + +- [Віддалені інстанси](/uk/remote-instances/) — підключайте десктопний застосунок до OpenChamber на іншій машині +- [Віддалений доступ](/uk/troubleshooting/remote-access/) — якщо SSH або віддалений доступ не підключається diff --git a/packages/docs/content/docs/zh-cn/ssh-hosts-proxying.mdx b/packages/docs/content/docs/zh-cn/ssh-hosts-proxying.mdx new file mode 100644 index 00000000..b14c25e3 --- /dev/null +++ b/packages/docs/content/docs/zh-cn/ssh-hosts-proxying.mdx @@ -0,0 +1,48 @@ +--- +title: SSH 主机与代理 +description: 在桌面应用中导入已保存的 SSH 主机并添加额外的 SSH 端口转发。 +--- + +# SSH 主机与代理 + +在桌面应用的 **Settings → Remote Instances** 中导入已保存的 SSH 主机，连接到远程机器，并通过同一个 SSH 连接开放额外端口。 + +> SSH 主机和 SSH 代理是**仅限桌面端**的功能。它们使用你电脑上的 SSH 客户端。 + +## 导入 SSH 主机 + +OpenChamber 可以读取你本地 SSH config 中的主机，也就是 `ssh work-server` 这类命令使用的同一个地方。 + +1. 打开 **Settings → Remote Instances**。 +2. 从 **Saved SSH hosts** 中选择一个主机。 +3. 如果主机是 pattern，输入真实目标，例如 `deploy@app.example.com`。 +4. 保存并连接。 + +OpenChamber 会用这个 SSH 命令创建 remote instance。当状态到达 **ready** 时，远程 OpenChamber UI 会在桌面应用中打开。 + +## 添加额外端口转发 + +每个 remote instance 都有 **Port Forwards** 区域。当 SSH 连接一侧需要访问另一侧的端口时使用它。 + +OpenChamber 支持三种转发类型： + +- **Local (-L)** — 在你的电脑上打开一个端口，连接到远程机器上的内容。 +- **Remote (-R)** — 在远程机器上打开一个端口，连接回你的电脑。 +- **Dynamic (-D)** — 通过 SSH 连接打开本地 SOCKS proxy。 + +对于大多数运行在远程机器上的 app preview 和 dashboard，请使用 **Local (-L)**。 + +## 使用 SOCKS proxy + +如果你希望电脑上的其他工具通过远程机器访问网络，请选择 **Dynamic (-D)**。OpenChamber 会为这个 SSH 连接打开一个本地 SOCKS proxy 端口。 + +连接 ready 后，从转发行复制或使用本地 proxy 地址。把你的浏览器或工具配置为使用它作为 SOCKS5 proxy。 + +## 保持私有 + +本地 bind host 请使用 `127.0.0.1` 或 `localhost`，除非你明确希望网络中的其他设备访问这个转发端口。 + +## 相关内容 + +- [远程实例](/zh-cn/remote-instances/) — 将桌面应用连接到另一台机器上的 OpenChamber +- [远程访问](/zh-cn/troubleshooting/remote-access/) — 当 SSH 或远程访问无法连接时 diff --git a/packages/docs/sidebar.config.json b/packages/docs/sidebar.config.json index 97be8e92..d4c8cf3f 100644 --- a/packages/docs/sidebar.config.json +++ b/packages/docs/sidebar.config.json @@ -468,6 +468,18 @@ "pl": "Tunele w aplikacji desktopowej" } }, + { + "label": "SSH Hosts & Proxying", + "link": "/ssh-hosts-proxying/", + "translations": { + "uk": "SSH-хости та проксі", + "zh-CN": "SSH 主机与代理", + "es": "Hosts SSH y proxy", + "pt-BR": "Hosts SSH e proxy", + "ko": "SSH 호스트 및 프록시", + "pl": "Hosty SSH i proxy" + } + }, { "label": "Updates", "link": "/updates/",