https://github.com/usememos/telegram-integration
Memogram is an easy to use integration service for syncing messages and images from a Telegram bot into your Memos.
https://github.com/usememos/telegram-integration
integration memos telegram telegram-bot
Last synced: 3 months ago
JSON representation
Memogram is an easy to use integration service for syncing messages and images from a Telegram bot into your Memos.
- Host: GitHub
- URL: https://github.com/usememos/telegram-integration
- Owner: usememos
- Created: 2024-05-09T14:17:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-24T11:22:43.000Z (4 months ago)
- Last Synced: 2025-03-29T02:01:51.946Z (4 months ago)
- Topics: integration, memos, telegram, telegram-bot
- Language: Go
- Homepage:
- Size: 7.66 MB
- Stars: 126
- Watchers: 2
- Forks: 29
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Memogram
**Memogram** is an easy to use integration service for syncing messages and images from a Telegram bot into your Memos.
## Prerequisites
- Memos service
- Telegram Bot
## Installation
Download the binary files for your operating system from the [Releases](https://github.com/usememos/telegram-integration/releases) page.
## Configuration
Create a `.env` file in the project's root directory and add the following configuration:
```env
SERVER_ADDR=dns:localhost:5230
BOT_TOKEN=your_telegram_bot_token
BOT_PROXY_ADDR=https://api.your_proxy_addr.com
```
The `SERVER_ADDR` should be a gRPC server address that the Memos is running on. It follows the [gRPC Name Resolution](https://github.com/grpc/grpc/blob/master/doc/naming.md).
## Usage
### Starting the Service
#### Starting with binary
1. Download and extract the released binary file;
2. Create a `.env` file in the same directory as the binary file;
3. Run the executable in the terminal:
```sh
./memogram
```
4. Once the bot is running, you can interact with it via your Telegram bot.
#### Starting with Docker
Or you can start the service with Docker:
1. Build the Docker image: `docker build -t memogram .`
2. Run the Docker container with the required environment variables:
```sh
docker run -d --name memogram \
-e SERVER_ADDR=dns:localhost:5230 \
-e BOT_TOKEN=your_telegram_bot_token \
memogram
```
3. The Memogram service should now be running inside the Docker container. You can interact with it via your Telegram bot.
#### Starting with Docker Compose
Or you can start the service with Docker Compose. This can be combined with the `memos` itself in the same compose file:
1. Create a folder where the service will be located.
2. Clone this repository in a subfolder `git clone https://github.com/usememos/telegram-integration memogram`
3. Create `.env` file
```sh
SERVER_ADDR=dns:yourMemosUrl.com:5230
BOT_TOKEN=your_telegram_bot_token
```
4. Create Docker Compose `docker-compose.yml` file:
```yaml
services:
memogram:
env_file: .env
build: memogram
container_name: memogram
```
5. Run the bot via `docker compose up -d`
6. The Memogram service should now be running inside the Docker container. You can interact with it via your Telegram bot.
### Interaction Commands
- `/start `: Start the bot with your Memos access token.
- Send text messages: Save the message content as a memo.
- Send files (photos, documents): Save the files as resources in a memo.
- `/search `: Search for the memos.