Merge pull request #65 from Fodesu/docs
Docs: add `create bot`, `platform telegram` sections
@@ -1,3 +1,5 @@
|
||||
import { text } from "node:stream/consumers";
|
||||
|
||||
export const en = [
|
||||
{
|
||||
text: 'Overview',
|
||||
@@ -26,6 +28,14 @@ export const en = [
|
||||
{
|
||||
text: 'Provider and Model',
|
||||
link: '/getting-started/provider-and-model.md'
|
||||
},
|
||||
{
|
||||
text: 'Create Bot',
|
||||
link: '/getting-started/create-bot.md'
|
||||
},
|
||||
{
|
||||
text: 'telegram platform',
|
||||
link: '/getting-started/platform-telegram.md'
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
# Create Bot
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Complete the provider and model configuration.
|
||||
|
||||
|
||||
## Step 1: Open the Bot Page
|
||||
|
||||
Click **Bots** in the left sidebar to open the Bots configuration page.
|
||||
|
||||
|
||||

|
||||
|
||||
|
||||
## Step 2: create a Bot
|
||||
|
||||
Click the **New Bot** button (with a plus icon)
|
||||
|
||||

|
||||
|
||||
In the dialog, fill in:
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **Name** | A display name for this bot (e.g. `my-bot`, `telegram-public-bot`) |
|
||||
| **Avatar URL** | The API base Avatar (e.g.`https://gravatar.com/avatar/***`) |
|
||||
| **Type** | Bots type: `person`, `public`, public for channel(e.g. `telegram` group, `qq` group, `discord` channel, person for bind user) |
|
||||
|
||||
## Step 3: Bot Configuration
|
||||
|
||||
Click one **bot** Card in Bots page
|
||||
|
||||

|
||||
|
||||
open **settings** section
|
||||
|
||||

|
||||
|
||||
select your available `Chat Model`, `Memory Model`, `Embedding Model` and save for basic Configuration
|
||||
|
||||
|
||||
## Step 4: Check Bot
|
||||
|
||||
Click **Chat** in the left sidebar to open chat page.
|
||||
then type your prompt to test the Bot configuration
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
## Next Steps
|
||||
|
||||
- add [channel](/concepts/channel) to `Platform`(e.g. [telegram](/getting-started/platform-telegram), `feishu(lark)`, `wechat`, `discord`)
|
||||
- manage your bot [Memory](/concepts/memory)
|
||||
@@ -0,0 +1,78 @@
|
||||
# Configure Telegram Channel
|
||||
|
||||
This guide walks you through connecting your bot to Telegram, allowing users to chat with your bot via Telegram messages.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Memoh is running (see [Docker installation](/installation/docker))
|
||||
- You have logged in to the Web UI at http://localhost:8082
|
||||
- You have created a bot (see [Create Bot](/getting-started/create-bot))
|
||||
- A Telegram account
|
||||
|
||||
## Step 1: Create a Telegram Bot
|
||||
|
||||
Open Telegram and search for the official bot `@BotFather`.
|
||||
|
||||
Send the `/newbot` command to BotFather and follow the prompts:
|
||||
|
||||
1. Enter a **name** for your bot (display name, e.g., `My Memoh Bot`)
|
||||
2. Enter a **username** for your bot (must end with `bot`, e.g., `my_memoh_bot`)
|
||||
|
||||
BotFather will create the bot and provide a **Bot Token** (e.g., `123456789:ABCdefGHIjklMNOpqrsTUVwxyz`).
|
||||
|
||||
**Save this token securely** — you will need it in the next step.
|
||||
|
||||
## Step 2: Open the Bot Platforms Page
|
||||
|
||||
In the Memoh Web UI, click **Bots** in the left sidebar to open the Bots page.
|
||||
|
||||
Select the bot you want to connect to Telegram.
|
||||
|
||||
Click the **Platforms** tab to open the channel configuration page.
|
||||
|
||||
## Step 3: Add Telegram Channel
|
||||
|
||||
Click the **Add Channel** button.
|
||||
|
||||
|
||||
|
||||
In the dialog, select **Telegram** as the channel type.
|
||||
|
||||
Fill in the configuration:
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **Bot Token** | The token from BotFather (e.g., `123456789:ABCdefGHIjklMNOpqrsTUVwxyz`) |
|
||||
|
||||
Click **Save** to add the channel.
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
## Step 4: Bind Your Telegram Account
|
||||
|
||||
Open the Memoh web ui setting page, find `Bind Code` section, select telegram platform and necessary TTL(seconds), Generate bind code.
|
||||
|
||||

|
||||
|
||||
|
||||
Open the bot dialog in telegram, send `Bind Code` to chat, you should get `Binding successful! Your identity has been linked.` message if successful
|
||||
|
||||
|
||||
Click **Save** to complete the binding.
|
||||
|
||||
## Step 6: Test the Connection
|
||||
|
||||
Send a message to your bot on Telegram:
|
||||
|
||||
- For `public` bots: Add the bot to a group, have others mention your bot when sending messages.
|
||||
- For `person` bots: Send a direct message (requires binding in Step 5)
|
||||
|
||||
The bot should respond according to its configured model and system prompt.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Configure [Memory](/concepts/memory) to enable long-term memory for your bot
|
||||
- Set up [Skills](/concepts/skills) to extend your bot's capabilities
|
||||
- Add [Schedules](/concepts/schedule) for automated tasks
|
||||
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 7.0 KiB |
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 47 KiB |
|
After Width: | Height: | Size: 21 KiB |
|
After Width: | Height: | Size: 43 KiB |
|
After Width: | Height: | Size: 10 KiB |