Update README.md
Browse files
README.md
CHANGED
|
@@ -1,143 +1,8 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
## 克隆仓库
|
| 10 |
-
|
| 11 |
-
```bash
|
| 12 |
-
git clone https://gitee.com/xyzqwefd/karin-puppeteer.git
|
| 13 |
-
```
|
| 14 |
-
|
| 15 |
-
## 进入目录
|
| 16 |
-
|
| 17 |
-
```bash
|
| 18 |
-
cd karin-puppeteer
|
| 19 |
-
```
|
| 20 |
-
|
| 21 |
-
## 安装依赖
|
| 22 |
-
|
| 23 |
-
> [!IMPORTANT]
|
| 24 |
-
> 中国大陆服务器请使用`cnpm`下载依赖`(自己什么网络你心里没点逼数嘛~)`
|
| 25 |
-
> 以下方式任选其一即可......
|
| 26 |
-
|
| 27 |
-
<details><summary>cnpm</summary>
|
| 28 |
-
|
| 29 |
-
```bash
|
| 30 |
-
# 使用官方源(国外服务器)安装
|
| 31 |
-
npm install -g cnpm
|
| 32 |
-
|
| 33 |
-
# 如果安装失败，请指定国内源npmmirror.com安装
|
| 34 |
-
npm --registry=https://registry.npmmirror.com install cnpm -g
|
| 35 |
-
```
|
| 36 |
-
|
| 37 |
-
```bash
|
| 38 |
-
cnpm install -P
|
| 39 |
-
```
|
| 40 |
-
|
| 41 |
-
</details>
|
| 42 |
-
|
| 43 |
-
<details><summary>npm</summary>
|
| 44 |
-
|
| 45 |
-
```bash
|
| 46 |
-
npm install -P
|
| 47 |
-
```
|
| 48 |
-
|
| 49 |
-
</details>
|
| 50 |
-
|
| 51 |
-
<details><summary>pnpm</summary>
|
| 52 |
-
|
| 53 |
-
```bash
|
| 54 |
-
npm install -g pnpm
|
| 55 |
-
```
|
| 56 |
-
|
| 57 |
-
```bash
|
| 58 |
-
pnpm install -P
|
| 59 |
-
```
|
| 60 |
-
|
| 61 |
-
</details>
|
| 62 |
-
|
| 63 |
-
<details><summary>yarn</summary>
|
| 64 |
-
|
| 65 |
-
```bash
|
| 66 |
-
npm install -g yarn
|
| 67 |
-
```
|
| 68 |
-
|
| 69 |
-
```bash
|
| 70 |
-
yarn install -P
|
| 71 |
-
```
|
| 72 |
-
|
| 73 |
-
</details>
|
| 74 |
-
|
| 75 |
-
## 前台启动
|
| 76 |
-
|
| 77 |
-
```bash
|
| 78 |
-
node .
|
| 79 |
-
```
|
| 80 |
-
|
| 81 |
-
## 后台运行
|
| 82 |
-
|
| 83 |
-
```bash
|
| 84 |
-
# 启动
|
| 85 |
-
pnpm start
|
| 86 |
-
|
| 87 |
-
# 停止
|
| 88 |
-
pnpm stop
|
| 89 |
-
|
| 90 |
-
# 重启
|
| 91 |
-
pnpm restart
|
| 92 |
-
|
| 93 |
-
# 查看日志
|
| 94 |
-
pnpm run log
|
| 95 |
-
```
|
| 96 |
-
|
| 97 |
-
## 配置文件
|
| 98 |
-
|
| 99 |
-
> [!IMPORTANT]
|
| 100 |
-
> 可修改：`config/config.yaml`
|
| 101 |
-
> 无效修改项：`config/config_default.yaml`
|
| 102 |
-
|
| 103 |
-
目前提供了两种连接方式，`WebSocket`和`Http`。
|
| 104 |
-
|
| 105 |
-
### `WebSocket(默认)`
|
| 106 |
-
|
| 107 |
-
- 优点
|
| 108 |
-
- 无需占用端口，无需修改`karin`的配置，开箱即用。
|
| 109 |
-
- 缺点：
|
| 110 |
-
- 需要将`karin-puppeteer`和`karin`放在同一台服务器、电脑上
|
| 111 |
-
|
| 112 |
-
可配置多个`karin`服务端，在配置文件添加`karinUrl`地址即可
|
| 113 |
-
|
| 114 |
-
```yaml
|
| 115 |
-
# 同时连接3个karin服务端
|
| 116 |
-
# karin 地址 可填写多个
|
| 117 |
-
karinUrl:
|
| 118 |
-
- "ws://localhost:7000/puppeteer" # 默认地址
|
| 119 |
-
- "ws://localhost:7001/puppeteer" # 地址1
|
| 120 |
-
- "ws://localhost:7002/puppeteer" # 地址2
|
| 121 |
-
|
| 122 |
-
```
|
| 123 |
-
|
| 124 |
-
### `Http(拓展)`
|
| 125 |
-
|
| 126 |
-
- 优点
|
| 127 |
-
- 可以将`karin-puppeteer`和`karin`放在不同的服务器上、不同的网络环境
|
| 128 |
-
- 如果`karin`有公网环境，可以连接公共的`karin-puppeteer`服务而做到`远程渲染`!
|
| 129 |
-
- 缺点：
|
| 130 |
-
- 需要占用端口，`karin`需要另外配置对应的插件
|
| 131 |
-
- 需要跟`karin`在一个内网或者都处于公网环境，因为需要`互相访问`...
|
| 132 |
-
- 需要将`karin`作为一个`express`服务器运行`(可能...会有安全问题?)`
|
| 133 |
-
|
| 134 |
-
此方式为扩展方式，默认关闭
|
| 135 |
-
|
| 136 |
-
```yaml
|
| 137 |
-
# HTTP 服务配置
|
| 138 |
-
http:
|
| 139 |
-
# 是否启用
|
| 140 |
-
enable: false
|
| 141 |
-
# HTTP 服务端口
|
| 142 |
-
port: 7005
|
| 143 |
-
```
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Basic Docker SDK Space
|
| 3 |
+
emoji: 🐳
|
| 4 |
+
colorFrom: purple
|
| 5 |
+
colorTo: gray
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_port: 7860
|
| 8 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|