diff --git a/README.md b/README.md index ea747e1..1c8d63c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,18 @@ The project uses your ChatGPT token to access the ChatGPT API and let you chat w Enough words, let's launch your personal ChatGPT Telegram bot. 🚀 +Key Features: + +* Saving the context of a conversation +* Access can be restricted by specifying a list of allowed users. +* Support for multiple chats for one user +* Support markdown in answers +* Ability to set behavior for the conversation, which will be preserved even when the context is cleared +* Docker and Proxy support +* Possibility to check expenses for the current month +* Tells you how many tokens you spent to generate a response +* Support Telegram Inline Mode + ## Preparing * You must have [Docker installed](https://docs.docker.com/engine/install/). You can run the project both on the PC and on the server. @@ -12,6 +24,14 @@ Enough words, let's launch your personal ChatGPT Telegram bot. 🚀 * You also need [ChatGPT access token](https://platform.openai.com/account/api-keys). * You must know your telegramId. [You can find it out here.](https://t.me/myidbot). +## Environment variables + +* `TELEGRAM_BOT_TOKEN` - The bot access token you got from GodFather. Example: 1234567890:XXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +* `TELEGRAM_BOT_USERNAME` - Specify a name with the ending bot here, not a public name. Example: Undusted_bot +* `TELEGRAM_PERSON_ID` - The IDs of the users on Telegram who are allowed access. Example: 1234567, 56789045 +* `ADMIN_TELEGRAM_PERSON_ID` - The IDs of the users on Telegram who are allowed admin access. Example: 1234567 +* `CHAT_GPT_TOKEN` - OpenAI API access token. + ## Docker Run The following platforms are supported: linux/amd64,linux/arm64/v8 @@ -21,12 +41,11 @@ docker run -it --name chatgpt-telegram-bot \ --env TELEGRAM_BOT_TOKEN= \ --env TELEGRAM_BOT_USERNAME= \ --env TELEGRAM_PERSON_ID= \ + --env ADMIN_TELEGRAM_PERSON_ID= \ --env CHAT_GPT_TOKEN= \ upagge/chatgpt-telegram-bot:develop ``` -`TELEGRAM_BOT_USERNAME` - Specify a name with the ending bot here, not a public name. - ### Telegram Proxy If you have Telegram blocked, you can specify proxy settings to connect. @@ -35,6 +54,7 @@ docker run -it --name chatgpt-telegram-bot \ --env TELEGRAM_BOT_TOKEN= \ --env TELEGRAM_BOT_USERNAME= \ --env TELEGRAM_PERSON_ID= \ + --env ADMIN_TELEGRAM_PERSON_ID= \ --env CHAT_GPT_TOKEN= \ --env TELEGRAM_PROXY_ENABLE=true \ --env TELEGRAM_PROXY_HOST= \ @@ -63,6 +83,7 @@ services: TELEGRAM_BOT_TOKEN: ${TELEGRAM_BOT_TOKEN} TELEGRAM_BOT_USERNAME: ${TELEGRAM_BOT_USERNAME} TELEGRAM_PERSON_ID: ${TELEGRAM_PERSON_ID} + ADMIN_TELEGRAM_PERSON_ID: ${ADMIN_TELEGRAM_PERSON_ID} CHAT_GPT_TOKEN: ${CHAT_GPT_TOKEN} ``` @@ -70,5 +91,6 @@ services: TELEGRAM_BOT_TOKEN= TELEGRAM_BOT_USERNAME= TELEGRAM_PERSON_ID= +ADMIN_TELEGRAM_PERSON_ID= CHAT_GPT_TOKEN= ``` \ No newline at end of file diff --git a/documentation/en/docs/demo.mp4 b/documentation/en/docs/demo.mp4 index 216dae2..0fda763 100644 Binary files a/documentation/en/docs/demo.mp4 and b/documentation/en/docs/demo.mp4 differ diff --git a/documentation/en/docs/index.md b/documentation/en/docs/index.md index 41ba84b..1448b9c 100644 --- a/documentation/en/docs/index.md +++ b/documentation/en/docs/index.md @@ -18,20 +18,86 @@ description: The project uses your ChatGPT token to access the ChatGPT API and l But seriously, the project uses your ChatGPT token to access the ChatGPT API and let you chat with ChatGPT directly in Telegram. -## Features +!!! danger "Disclaimer" + + This is a personal project and is not affiliated with OpenAI in any way. + +## Demo See for yourself how easy and convenient it is to use ChatGPT in Telegram. It is better to see once than to hear 100 times. -