https://github.com/ffreemt/koyeb-nb2
Nonebot2 up and running with ease
https://github.com/ffreemt/koyeb-nb2
docker go-cqhttp nonebot2
Last synced: 6 months ago
JSON representation
Nonebot2 up and running with ease
- Host: GitHub
- URL: https://github.com/ffreemt/koyeb-nb2
- Owner: ffreemt
- Created: 2021-07-15T08:17:45.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T02:15:19.000Z (over 2 years ago)
- Last Synced: 2023-03-04T20:34:34.680Z (about 2 years ago)
- Topics: docker, go-cqhttp, nonebot2
- Language: Python
- Homepage:
- Size: 36.2 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# koyeb-nb2
[](https://v2.nonebot.dev/)[](https://v2.nonebot.dev/guide/cqhttp-guide.html)[](https://img.shields.io/static/v1?label=python+&message=3.7%2B&color=blue)[](https://github.com/psf/black)[](https://opensource.org/licenses/MIT)
Nonebot2 up and running with ease
([中文](https://github.com/ffreemt/koyeb-nb2/blob/master/dumbot.md))
## Oneclick start
- Authenticate when necessary
`cd go-cqhttp` && `go-cqhttp` # or ./go-cqhttp in Linux/Mac
or copy valid `config.yml` `session.token` `session.token` to the `go-cqhttp` directory.
- Run `start_nb.py` in the `koyeb-nb2` directory
```python
python start_nb2.py
```
or click `run-python-start_nb2.bat` (in Windows).
## Setup details
### Clone/fork this repo
E.g.
```bash
git clone https://github.com/ffreemt/koyeb-nb2
```
### Authenticate
In `go-cqhttp-940fix5`, run `go-cqhttp` and ready `config.hjson`/` device.json`
换到`go-cqhttp`目录里。运行`go-cqhttp` 生成config.hjson。编辑`config.hjson`填上机器人的qq号和密码，参考config.hjson- 修改reverse_url 及设置端口（8680）。再次运行 `go-cqhttp` 完成验证生成 `device.json`
## Three ways to use it
### Run it in Docker Locally
In `koyeb-nb`
1. run
```
docker build -t koyeb-nb -f Dockerfile.gocqhttp-nb2 .`
```
2. run `docker run --rm koyeb-nb`
3. (Optional) Upload to Docker Hub ([https://hub.docker.com/](https://hub.docker.com/))
```
export DOCKER_ID=your_docker_id # hub.docker.com
docker tag koyeb-nb:latest $DOCKER_ID/koyeb-nb:latest
docker push $DOCKER_ID/koyeb-nb:latest
```
4. Test the bot
* Send a private message to the bot: `/echo hey ya`
* Send a group message to the bot: `@botname /echo sup`
5. Install more plugins and repeat 1-2.
For example, `poetry add nonebot-plugin-guess`
Readily made plugins are available
[https://v2.nonebot.dev/store.html](https://v2.nonebot.dev/store.html)
You can also copy plugin directly to koyeb_nb2/plugins.
### Run it in Docker in Cloud
For example, in `koyeb` and such serverless services that support docker deployments.
### **For Testing Plugins Locally 本地开发测试插件**
Optionally use a venv, e.g., `python -m venv venv && source venv/bin/activate` in Linux or `python -m venv venv && venv/Scripts/activate` in Windows.
1. Install packages
In `koyeb-nb`, run `pip install -r requirements.text`
Or run `poetry install` and **`pip install nonebot2 -U`** since we need `nonebot2a13post1` but poetry cannot handle `post`.
2. Run `go-cqhttp`/`nonebot` and make your own plugin
* In `go-cqhttp-940fix5`, run `go-cqhttp`
N.B. For Windows, download and run go-cqhttp.exe
* In `koyeb-nb`, run `uvicorn --port 8680 bot:app --reload --reload-dir koyeb_nb2`
* In `koyeb_nb2/plugins`, create/edit/save `fancy_plugin.py`