Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pkarpovich/tg-link-keeper-bot
A Telegram bot for efficiently saving links and memo files in Cubox, featuring user role management and integration with external link storage services
https://github.com/pkarpovich/tg-link-keeper-bot
cubox link-keeper memos telegram-bot
Last synced: about 2 months ago
JSON representation
A Telegram bot for efficiently saving links and memo files in Cubox, featuring user role management and integration with external link storage services
- Host: GitHub
- URL: https://github.com/pkarpovich/tg-link-keeper-bot
- Owner: pkarpovich
- License: mit
- Created: 2023-12-15T22:28:45.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-28T00:03:50.000Z (2 months ago)
- Last Synced: 2024-10-28T02:16:53.410Z (2 months ago)
- Topics: cubox, link-keeper, memos, telegram-bot
- Language: Go
- Homepage:
- Size: 58.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram Link Keeper Bot
Link Keeper Bot is a Telegram bot designed to save links or memo files in Cubox. It processes different types of
messages including URLs and forwarded messages.
## Features
- Save URLs and text memos.
- Process forwarded messages from Telegram.
- Restrict access to specified 'Super Users'.
- Integrate with an external link storage service (Cubox).
## Requirements
- Docker and Docker Compose
- Telegram Bot API token
- Access to a Cubox instance or similar service for link storage
## Installation
1. Clone the repository:
```bash
git clone [email protected]:pkarpovich/tg-link-keeper-bot.git
```
2. Navigate to the project directory:
```bash
cd tg-link-keeper-bot
```
## Configuration
1. Create a .env file in the project root with the following contents:
```bash
TELEGRAM_TOKEN=your_telegram_bot_token
TELEGRAM_SUPER_USERS=user_id1,user_id2
LINK_STORE_URL=your_link_store_endpoint
```
2. Adjust the values for `TELEGRAM_TOKEN`, `TELEGRAM_SUPER_USERS`, and `LINK_STORE_URL` according to your setup.
## Docker Deployment
1. Use the provided Docker Compose file to deploy the bot:
```bash
docker compose pull
docker compose up -d
```
2. The bot will be running in a container named tg-link-keeper-bot.
## Usage
- Send a URL or a forwarded message to the bot to save it in Cubox.
- Send a text message to the bot to save it as a memo in Cubox.
- Interact with the bot in Telegram. Use the /ping command to check its status.
## Commands
- `/ping` - Check if the bot is online.
## License
[MIT](https://choosealicense.com/licenses/mit/)