Skip to content

KarinJS/karin-puppeteer

Repository files navigation

简介

适用于 KarinPuppeteer

本仓库使用的Puppeteer13.7.0版本的,不推荐使用外置chromium


克隆仓库

国外推荐(GitHub)

git clone --depth=1 https://github.com/KarinJS/karin-puppeteer.git

国内推荐(ghproxy)

git clone --depth=1 https://mirror.ghproxy.com/https://github.com/KarinJS/karin-puppeteer.git

进入目录

cd karin-puppeteer

安装依赖

Important

中国大陆服务器请使用cnpm下载依赖(自己什么网络你心里没点逼数嘛~) 以下方式任选其一即可......

cnpm
# 使用官方源(国外服务器)安装
npm install -g cnpm

# 如果安装失败,请指定国内源npmmirror.com安装
npm --registry=https://registry.npmmirror.com install cnpm -g
cnpm install -P
npm
npm install -P
pnpm
npm install -g pnpm
pnpm install -P
yarn
npm install -g yarn
yarn install -P

前台启动

node .

后台运行

# 启动
pnpm start

# 停止
pnpm stop

# 重启
pnpm restart

# 查看日志
pnpm run log

配置文件

Important

可修改:config/config.yaml
无效修改项:config/config_default.yaml

目前提供了两种连接方式,WebSocketHttp

WebSocket(默认)

  • 优点
    • 无需占用端口,无需修改karin的配置,开箱即用。
  • 缺点:
    • 需要将karin-puppeteerkarin放在同一台服务器、电脑上

可配置多个karin服务端,在配置文件添加karinUrl地址即可

# 同时连接3个karin服务端
# karin 地址 可填写多个
karinUrl:
  - "ws:https://localhost:7000/puppeteer" # 默认地址
  - "ws:https://localhost:7001/puppeteer" # 地址1
  - "ws:https://localhost:7002/puppeteer" # 地址2

Http(拓展)

  • 优点
    • 可以将karin-puppeteerkarin放在不同的服务器上、不同的网络环境
    • 如果karin有公网环境,可以连接公共的karin-puppeteer服务而做到远程渲染!
  • 缺点:
    • 需要占用端口,karin需要另外配置对应的插件
    • 需要跟karin在一个内网或者都处于公网环境,因为需要互相访问...
    • 需要将karin作为一个express服务器运行(可能...会有安全问题?)

此方式为扩展方式,默认关闭

# HTTP 服务配置
http:
  # 是否启用
  enable: false
  # HTTP 服务端口
  port: 7005