Koipy
  • koipy测试机器人
  • 快速开始
  • 配置模板
  • 激活
  • 友情链接
  • 文档
    • 配置详解
      • 必填配置
      • bot
      • network
      • image
      • scriptConfig
    • 指令详解
      • /test
      • /rule
      • /log
      • /remove
      • /help
      • /re
      • /checkslave
      • /subinfo
      • /reload
      • /setantigroup
      • /leave
      • /grant
      • /nightshift
      • /panel
      • 指令参数
      • 位置参数
    • 自定义指令
    • 关于规则
      • 指令映射
    • 回调功能
    • 以旁路模式运行bot
    • MiaoSpeed后端
      • 介绍
      • 搭建指南
        • docker使用
      • 测试脚本编写
        • 第一个测试脚本
        • 预设函数
          • 发起POST请求
      • MMDB数据库
      • 历史过往
    • 语言包
      • 导入语言包
      • 制作语言包
    • 问题答疑
      • 无法获取订阅
      • 关于连通性测试
      • 关于拓扑测试
    • 更新日志
      • v1.8.X
      • v1.7.X
      • v1.6.X
      • v1.5.X
      • v1.4.2
      • v1.4
      • v1.3
    • 合作开发
    • 赞赏支持
Powered by GitBook
On this page
  • 前提
  • 配置文件
  • 常规启动
  • Docker启动

快速开始

Previouskoipy测试机器人Next配置模板

Last updated 4 months ago

前提

没有一丁点的计算机知识,建议放弃,建议放弃,建议放弃。

首先需要准备以下信息:

  • 去 那里创建一个机器人,获得该机器人的bot_token,应形如:

    bot_token = "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"

    这步不会请Google。

可选信息:

⚠️koipy从1.2版本开始内置api_hash, api_id,你仅需要bot_token即可开始玩耍。当然你想用自己的api也可以。

  • Telegram 的api_id 、api_hash 不会请Google。(部分TG账号已被拉黑,无法正常使用,尝试更换代理IP,IP干净成功率高,用机场节点就自求多福吧🙃)

配置文件

在项目根目录创建config.yaml

以下是最基本的必需配置:

license: xxxxxxxxxxx  # 激活码,必填。否则无法使用
bot:
  bot-token: 123456:abcdefg # bot的token, 首次启动必填,替换你自己的
  #api-id:  # telegram的 api_id 选填
  #api-hash:  # telegram的 api_hash 选填

v1.9.1版本开始支持环境变量:

KOIPY_LICENSE=激活码

KOIPY_BOT_TOKEN=bot-token

KOIPY_BOT_PROXY=bot运行代理

使用例子:

export KOIPY_LICENSE=激活码

激活码获取请查看:

首次启动会加载一些资源文件,如果需要代理加速,请在配置文件加上:

#config.yaml
network: # 网络
  httpProxy: "http://host:port" # http代理,如果设置的话,bot会用这个拉取订阅
  socks5Proxy: "socks5://host:port" # socks5代理, bot的代理在下面bot那一栏填
# 如果bot需要代理:
bot:
  proxy: socks5://127.0.0.1:11112 # socks5代理
  bot-token: 123456:abcdefg # bot的token, 首次启动必填,替换你自己的
  #proxy: http://127.0.0.1:11112 # http代理也支持
  #api-id:  # telegram的 api_id 选填
  #api-hash:  # telegram的 api_hash 选填

常规启动

以下操作均在linux的bash环境下运行,提示找不到命令请自行安装对应软件包

解压打包好的文件:

unzip koipy-linux-amd64.zip

赋予执行权限并执行:

sudo chmod +x koipy && ./koipy 

Docker启动

挂载配置文件启动:

docker run -itd \
--name=koipy-app \
--network=host \
--restart=always \
-v ./config.yaml:/app/config.yaml \
koipy/koipy
  • arm64 架构镜像:

docker run -itd \
--name=koipy-app \
--network=host \
--restart=always \
-v ./config.yaml:/app/config.yaml \
koipy/koipy:arm64

检查是否成功启动:

docker logs -f koipy-app

不出意外你将看到类似提示:

更多配置设置请查看:

配置文件示例位于 ./resources/config.example.yaml

@BotFather
获取地址
激活
配置模板
配置详解