chore: init

README.md

@@ -0,0 +1,179 @@
+# My Point VPN
+
+Предоставляет интерфейс чат бота в телеграмм посредством которого позволяет разворачивать 3x-ui на своем сервере и выпускать ключи.
+
+Базово конфигурируется 3x-ui на создание vless подключений с tls+reality маскировкой трафика. Настраивается dns, подписка и базовая безопасность сервера. Пользователь может прикрутить прокси на выход или включить cf_warp прокси. По каждому серверу дает базовую статистику у ручки управления.
+
+Если вам нужен приватный доступ в интернет, передайте сервер боту и он настроит вам его. Выглядит это так: пользователь заводит аккаунт хостинг провайдера, арендует сервер, ему выдают ip и пароль root, он передает их боту, оный настраивает сервер, теперь пользователь может выпускать ключи vless и подключаться к интернету безопасно и приватно.
+
+- статистика сервера:
+  - сколько трафика пропустил
+  - сколько пользователей
+  - можно добавить пользователя
+- статистика по пользователю:
+  - онлайн?
+  - сколько трафика пропустил
+  - можно удалить пользователя
+
+Серверу можно настроить:
+
+- прокси на выходе (cf или свои)
+- домен (можно спрятать за cf, сертификат получим у certbot)
+
+### Интерфейс чата
+
+Переход в главное меню должен быть реализован кнопкой в клавиатуре. `/start` и кнопка "главное меню" должны выполняться одним методом.
+
+```
+---> 
+/start
+<---
+привет. выбери действие
+[ФАК][добавить сервер][помощь]
+```
+
+```
+--->
+добавить сервер
+<---
+отправь данные для подключения к серверу
+`ip:root_password`
+[отмена]
+```
+
+```
+--->
+127.0.0.1:toor
+<---
+запускаю активацию сервера.
+я отправлю уведомление, когда все будет готово.
+```
+
+```
+--->
+<---
+сервер ip - проименован как `NAME`, готов к работе.
+[меню сервера]
+```
+
+```
+--->
+/start
+<---
+server_name	0Mb/0Mb	0/0
+[ФАК][добавить сервер][помощь][управление сервером]
+```
+
+```
+--->
+управление сервером
+<---
+Пришлите server_name
+[отмена]
+```
+
+```
+--->
+меню сервера
+<---
+Сервер: NAME
+Состояние: активен
+Ключи: 0/0
+Домен: -
+Прокси: -
+[Вернуть][Переустановить]
+[Домен][Прокси][Cloudflare]
+[Клиенты]
+```
+
+```
+--->
+Вернуть
+<---
+Сервер будет освобожден из-под моего контроля, 
+будет установлен случайный пароль рута,
+мои доступы будут убраны, данные на сервере сохранены.
+Будет отправлено уведомление с новым паролем. Продолжить?
+[Да][Нет]
+```
+
+```
+--->
+Переустановить
+<---
+Будет произведена повторная установка всех компонентов.
+Вызывайте эту функцию, только после того, как в панеле управления 
+сервером в аккаунте хостинг провайдера вызовите переустановку сервера.
+Если уверены, то пришлите новый пароль сервера.
+[Отмена]
+```
+
+```
+--->
+Домен
+<---
+Сейчас установлен: -
+Доменное имя лучше подходит для маскировки вашей точки доступа.
+[установить][отключить]
+```
+
+```
+--->
+Прокси
+<---
+Сейчас установлено: -
+Позволяют маскировать ip адрес вашей точки доступа от сайтов, 
+которые посещаются.
+
+X -> Cloudflare <> MyPoint <> PROXY <- Web
+
+X через домен видит ip от cloudflare, а web сайты видят ip прокси, 
+это позволяет вашей точке доступа оставаться инкогнито. 
+
+[установить][отключить]
+```
+
+```
+--->
+Cloudflare
+<---
+Сейчас активировано: Нет
+Позволяет защитить ip адрес вашей точки доступа от клиентов, 
+которые к ней подключаются.
+
+X -> Cloudflare <> MyPoint <> PROXY <- Web
+
+[установить][отключить]
+```
+
+```
+--->
+Клиенты
+<---
+id	0/0Mb	On
+[добавить][удалить][получить ключ]
+```
+
+```
+--->
+удалить
+<---
+Чтобы удалить клиента пришлите его id
+[отмена]
+```
+
+```
+--->
+добавить
+<---
+если хотите, можете сами установить id
+[сгенерируй]
+```
+
+Далее пользователь либо отправляет текст, который будет использован как id для нового клиента, либо сгенерирует новый уникальный id и вернет ключ.
+
+### Настройка сервера
+
+### Функционал бота
+
+### Модель данных