mirror of
https://github.com/kemko/memes-telegram-integration.git
synced 2026-01-01 15:55:41 +03:00
ba7534e590
* fix: url in bot message * Update .env.example Co-authored-by: boojack <24653555+boojack@users.noreply.github.com> * feat: rename MEMOS_ADDR to INSTANCE_URL * feat: rename MEMOS_ADDR to INSTANCE_URL * feat: rename MEMOS_ADDR to INSTANCE_URL * fix: formatting --------- Co-authored-by: boojack <24653555+boojack@users.noreply.github.com>
87 lines
2.6 KiB
Markdown
87 lines
2.6 KiB
Markdown
# 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
|
|
INSTANCE_URL=https://memos.example.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
|
|
INSTANCE_URL=https://memos.example.com
|
|
```
|
|
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 <access_token>`: 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 <words>`: Search for the memos.
|