Skip to content

Latest commit

 

History

History
138 lines (88 loc) · 5.31 KB

README.md

File metadata and controls

138 lines (88 loc) · 5.31 KB
Raw

TeleGPT

API Docs | Releases | Twitter

Hero

An out-of-box ChatGPT bot for Telegram.

TeleGPT is a Telegram bot based on teloxide framework and async_openai. It provides an easy way to interact with the latest ChatGPT models utilizing your own API key.

Features

🦀 Lightning fast with pure Rust codebase.
📢 All types of chat (private and group) supports.
🚀 Live streaming tokens to your message bubble.
⌨️ Telegram-flavoured Markdown rendering supports.
💸 Token usage statistic recording and queryable via commands.
⚙️ Fully customizable with file-based configuration.
✋ Admin features (Beta) and user access control supports.

Getting TeleGPT

Docker

We recommend you to use the prebuilt docker image when deploying a dedicated server, it is published through GitHub Container Registry by GitHub Action. Currently, machines with amd64 architecture are supported.

  1. Sign in to GitHub Container Registry (needed if unauthorized when pull):
docker login -u your_github_username -p your_personal_access_token https://ghcr.io
  1. Create a config.json file with the template:
cp config.json.example config.json

Follow the instructions below to fill in tokens in config.json.

  1. Start the docker container:
docker-compose up -d # start the container

Other commands you may find useful:

docker-compose logs -f # check the logs, press ctrl+c to stop viewing
docker-compose down # stop the container
docker-compose pull # pull the latest image

Download from release

To deploy or test in-house, you can download the pre-built binary directly from the releases page. Currently, Linux and macOS (Intel and Apple Silicon) hosts are supported.

Build from source

Clone the repository and run:

$ cargo build --release

Usage

You need to create a configuration file before running the bot. The program reads telegpt.config.json from your current working directory by default, and you can also specify the config file path via -c option.

The configuration is described in this doc, and here is an example:

{
  "openaiAPIKey": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "botToken": "8888888888:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "adminUsernames": ["cyandev"],
  "conversationLimit": 30,
  "databasePath": "./path/to/telegpt.sqlite",
  "i18n": {
    "resetPrompt": "I’m ready for a new challenge. What can I do for you now?"
  }
}

To start the bot, simply run:

$ /path/to/telegpt

When you see the message Bot is started, you are ready to go!

Enable the verbose logging

Note: Users' input will be logged in DEBUG level. To protect user privacy, please don't enable it in the production environment.

For debugging purpose, you can enable the verbose logs by setting RUST_LOG environment variable. For example:

$ RUST_LOG=TRACE /path/to/telegpt

Admin Features (Beta)

This feature depends on database to store the configurations. To ensure your data will not be lost after relaunching, you need to set a database path in the config file.

The bot has some basic admin features built-in. You can control who are allowed to use the bot, and dynamically change the member list via a set of commands.

By default, the bot is available for public use. It means everybody who adds it can chat with it, which may heavily cost your tokens. If you want to deploy and use the bot only within a small group of people, send /set_public off command to make the bot private. When you want to make it public again, send /set_public on.

When the bot is in private mode, only admin users and invited members can chat with it. You can add or delete members via /add_member and /del_member command. The argument is username. For example: /add_member cyandev.

Currently, only admin users can use admin commands, other member users are not allowed to use them.

Database

The bot will use SQLite database to store some data produced during runtime. By default, if you don't provide a local file path, the data will be stored in memory database. When you restart the bot, all previous data (such as added members) will be lost. We recommend you to use the file-based database for usability.

Roadmap

TeleGPT will be actively maintained recently, there are some planned features that are in development.

  • Retry with exponential backoff.
  • Conversation presets.
  • More user-friendly interface for admin operations.
  • Remote controlling with HTTP APIs.

Contribution

Issues and PRs are welcomed. Before submitting new issues or PRs, it's better to check the existing ones first. Discussions and feature requests are nice to have before you start working on something.

License

MIT