docs: add Remote Access section with Telegram Gateway documentation (#7955)
Signed-off-by: Rizel Scarlett <rizel@squareup.com>
This commit is contained in:
Rizel Scarlett
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Remote Access
|
||||
sidebar_position: 2
|
||||
description: Access goose remotely from mobile devices and messaging platforms.
|
||||
---
|
||||
|
||||
import Card from '@site/src/components/Card';
|
||||
import styles from '@site/src/components/Card/styles.module.css';
|
||||
|
||||
# Remote Access
|
||||
|
||||
Access goose from anywhere using mobile apps or messaging platforms. These features let you interact with goose when you're away from your computer.
|
||||
|
||||
<div className={styles.cardGrid}>
|
||||
<Card
|
||||
title="Mobile Access via Secure Tunneling"
|
||||
description="Connect to goose Desktop from the goose AI iOS app using secure tunneling."
|
||||
link="/docs/experimental/remote-access/mobile-access"
|
||||
/>
|
||||
<Card
|
||||
title="Telegram Gateway"
|
||||
description="Chat with goose through Telegram from any device."
|
||||
link="/docs/experimental/remote-access/telegram-gateway"
|
||||
/>
|
||||
</div>
|
||||
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: Mobile Access via Secure Tunneling
|
||||
sidebar_position: 1
|
||||
sidebar_label: Mobile Access
|
||||
description: Enable remote access to goose from mobile devices using secure tunneling.
|
||||
---
|
||||
|
||||
import { PanelLeft } from 'lucide-react';
|
||||
|
||||
Mobile access lets you connect to goose remotely from an iOS mobile device using secure tunneling.
|
||||
|
||||
:::warning Experimental Feature
|
||||
Mobile access is a preview feature in active development. Behavior and configuration may change in future releases.
|
||||
:::
|
||||
|
||||
## How Mobile Access Works
|
||||
|
||||
Mobile access connects your iOS device to goose Desktop through a secure tunnel. After you install and configure the **goose AI** app, you can access goose from anywhere.
|
||||
|
||||
**Key details:**
|
||||
- Uses [Lapstone](https://github.com/michaelneale/lapstone-tunnel), a public HTTPS tunnel service provided by Mic Neale
|
||||
- Easy setup using a QR code with a unique secret key to secure the connection
|
||||
- Your tunnel URL remains the same across sessions, so you only need to configure your mobile app once
|
||||
- The connection requires your computer to be awake with goose Desktop running
|
||||
- Automatically reconnects if interrupted and restarts when you launch goose Desktop
|
||||
|
||||
## Setup
|
||||
|
||||
### Install the App
|
||||
1. Install the **goose AI** app on your iOS mobile device from the [App Store](https://apps.apple.com/app/goose-ai/id6752889295)
|
||||
|
||||
:::tip App Store QR Code
|
||||
Follow the steps below to open the `Remote Access` section, then click "scan QR code" in the info box for quick access to the App Store.
|
||||
:::
|
||||
|
||||
### Start the Tunnel
|
||||
1. Open goose Desktop
|
||||
2. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
|
||||
3. Click `Settings` in the sidebar
|
||||
4. Click `App`
|
||||
5. Scroll down to the `Remote Access` section and click `Start Tunnel`
|
||||
|
||||
Once the tunnel starts, you'll see a `Remote Access Connection` QR code for configuring the app.
|
||||
|
||||
:::info
|
||||
Click `Stop Tunnel` at any time to close the connection.
|
||||
:::
|
||||
|
||||
### Connect the App
|
||||
1. Open the **goose AI** app on your iOS mobile device
|
||||
2. Scan the `Remote Access Connection` QR code displayed in goose Desktop
|
||||
3. The app will automatically configure the connection
|
||||
|
||||
You can now access goose Desktop from your mobile device.
|
||||
|
||||
## What You Can Do
|
||||
|
||||
The mobile app gives you full access to goose:
|
||||
- Start new conversations or continue existing sessions
|
||||
- Use all your goose extensions and configurations
|
||||
- Work from anywhere while your computer handles the processing
|
||||
|
||||
## Additional Resources
|
||||
|
||||
import ContentCardCarousel from '@site/src/components/ContentCardCarousel';
|
||||
import mobileShots from '@site/blog/2025-12-19-goose-mobile-terminal/mobile_shots.png';
|
||||
|
||||
<ContentCardCarousel
|
||||
items={[
|
||||
{
|
||||
type: 'blog',
|
||||
title: 'goose Mobile Access and Native Terminal Support',
|
||||
description: 'Learn about two new ways to use goose: iOS app for mobile access and native terminal support with seamless session continuity.',
|
||||
thumbnailUrl: mobileShots,
|
||||
linkUrl: '/goose/blog/2025/12/19/goose-mobile-terminal',
|
||||
date: '2025-12-19',
|
||||
duration: '4 min read'
|
||||
}
|
||||
]}
|
||||
/>
|
||||
@@ -0,0 +1,106 @@
|
||||
---
|
||||
title: Telegram Gateway
|
||||
sidebar_position: 2
|
||||
sidebar_label: Telegram Gateway
|
||||
description: Chat with goose through Telegram from any device.
|
||||
---
|
||||
|
||||
The Telegram Gateway lets you interact with goose through Telegram, enabling remote access from any device where Telegram is available.
|
||||
|
||||
:::warning Experimental Feature
|
||||
The Gateway feature is experimental and in active development. Behavior and configuration may change in future releases.
|
||||
:::
|
||||
|
||||
## How It Works
|
||||
|
||||
The Gateway connects your Telegram account to goose through a secure pairing process. Once paired, you can send messages to a Telegram bot that forwards them to goose, and receive formatted responses back in Telegram.
|
||||
|
||||
**Key details:**
|
||||
- Uses a Telegram bot that you create and configure
|
||||
- Secure pairing with a one-time code
|
||||
- Supports formatted responses with code blocks and markdown
|
||||
- Maintains a persistent session that auto-compacts for long conversations
|
||||
- Works from any device with Telegram installed
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before setting up the Telegram Gateway, you need to create a Telegram bot:
|
||||
|
||||
1. Open Telegram and search for [@BotFather](https://t.me/BotFather)
|
||||
2. Send `/newbot` and follow the prompts to create your bot
|
||||
3. Copy the **bot token** that BotFather provides (looks like `123456789:ABCdefGHIjklMNOpqrsTUVwxyz`)
|
||||
|
||||
:::tip
|
||||
Keep your bot token secure. Anyone with the token can control your bot.
|
||||
:::
|
||||
|
||||
## Setup
|
||||
|
||||
### Desktop App
|
||||
|
||||
1. Open goose Desktop
|
||||
2. Go to **Settings** > **Gateways**
|
||||
3. In the Telegram section, enter your bot token
|
||||
4. Click **Start** to activate the gateway
|
||||
5. Click **Generate Pairing Code** to get a one-time pairing code
|
||||
|
||||
### Pair Your Telegram Account
|
||||
|
||||
1. Open Telegram and find your bot (search for the username you gave it)
|
||||
2. Send the pairing code to the bot
|
||||
3. The bot will confirm the pairing is complete
|
||||
|
||||
You can now chat with goose through Telegram!
|
||||
|
||||
### CLI Usage
|
||||
|
||||
You can also manage the gateway from the command line:
|
||||
|
||||
```bash
|
||||
# Check gateway status
|
||||
goose gateway status
|
||||
|
||||
# Start the Telegram gateway
|
||||
goose gateway start telegram --bot-token YOUR_BOT_TOKEN
|
||||
|
||||
# Generate a pairing code
|
||||
goose gateway pair telegram
|
||||
|
||||
# Stop the gateway
|
||||
goose gateway stop telegram
|
||||
```
|
||||
|
||||
## What You Can Do
|
||||
|
||||
Once paired, you can:
|
||||
- Send messages to goose and receive responses
|
||||
- Get formatted code blocks with syntax highlighting
|
||||
- Continue conversations across multiple sessions
|
||||
- Access all your configured goose extensions
|
||||
|
||||
## Managing Paired Users
|
||||
|
||||
From the Desktop app's Gateway settings, you can:
|
||||
- View all paired Telegram users
|
||||
- See which session each user is connected to
|
||||
- Unpair users to revoke their access
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Bot not responding
|
||||
- Verify the bot token is correct
|
||||
- Check that the gateway is running in goose Desktop
|
||||
- Ensure your computer is awake and goose Desktop is open
|
||||
|
||||
### Pairing code not working
|
||||
- Pairing codes expire after a few minutes—generate a new one
|
||||
- Make sure you're sending the code to the correct bot
|
||||
|
||||
### Messages not formatting correctly
|
||||
- The gateway converts goose's markdown to Telegram-compatible formatting
|
||||
- Some complex formatting may be simplified for Telegram compatibility
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Telegram Bot API Documentation](https://core.telegram.org/bots)
|
||||
- [Gateway PR #7199](https://github.com/block/goose/pull/7199)
|
||||
Reference in New Issue
Block a user