# iwiki

**Repository Path**: xindonhub/iwiki

## Basic Information

- **Project Name**: iwiki
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 11
- **Created**: 2026-07-04
- **Last Updated**: 2026-10-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sse-iwiki

SSE Market 软工学院知识库：**多知识库空间 · Markdown 所见即所得 · CodeWiki · 三路合并协同 · 权限管理 · AI 检索问答**

> 仓库：https://gitee.com/xindonhub/iwiki
> 文档中心：[`docs/README.md`](./docs/README.md)

---

## 环境

| 环境 | 地址 | 说明 |
|------|------|------|
| 测试 | https://test.iwiki.ssemarket.cn/ | **所有改动先上测试验收** |
| 正式 | https://iwiki.ssemarket.cn/ | 兼容旧入口 https://ssemarket.cn/iwiki/ |
| 健康检查 | `GET /iwiki-api/health` | 前后端同域，Nginx 反代 `/iwiki-api` |

---

## 结构

```
apps/iwiki-web/       # 前端 Vue 3 + Vite + Pinia
apps/iwiki-api/       # 后端 Express + better-sqlite3
packages/sse-ui/      # 共享 UI 组件库
deploy/               # Docker / Nginx / 拆分包配置
docs/                 # 产品与技术文档
```

---

## 快速开始

```bash
npm install
npm run dev:api   # http://localhost:3001
npm run dev:web   # http://localhost:5173
```

- 前端 `/api` 由 Vite 代理到 `:3001`
- 本地 OAuth：`OAUTH_REDIRECT_URI=http://localhost:5173/oauth/callback`

---

## 部署（发布流水线）

线上发布由 `/root/SSE_Market/iWiki/iwiki.py` 统一负责，**拉代码 → 部署测试 → 验收 → 部署正式**：

```bash
python3 iwiki.py pull                 # 拉最新代码并构建 release
python3 iwiki.py pull -b feat/x       # 构建指定分支（构建后切回原分支）
python3 iwiki.py test                 # 部署测试站
python3 iwiki.py test -b feat/x       # 构建该分支并直接部署测试站
python3 iwiki.py prod                 # 部署正式站
python3 iwiki.py test <release-id>    # 部署指定 release
python3 iwiki.py rollback prod        # 回滚正式站到上一个 release
python3 iwiki.py status               # 查看部署状态 / 容器 / 证书 / 磁盘
python3 iwiki.py releases             # 列出所有 release
python3 iwiki.py logs                 # 跟随查看容器日志
```

约定：

- release 命名 `YYYYMMDD-HHMMSS-<短 SHA>`，产物存于 `releases/`
- 测试与正式数据完全隔离，共用同一套额度/服务
- 分支改动走 PR 审批，**不直接合并 master**
- 详细步骤（编译、Nginx、Docker、`.env`）→ [部署指南](./docs/部署指南.md)

---

## 关键环境变量

见 `deploy/split/api/.env.example`：

| 变量 | 说明 |
|------|------|
| `OAUTH_*` | SSE Market OAuth 接入（含多回调地址 / 子域密钥） |
| `IWIKI_DATA_DIR` / `IWIKI_UPLOAD_DIR` | SQLite 与上传图片持久化目录 |
| `IWIKI_SECRET_SM4_KEY` | 敏感配置落库主密钥（32 位 hex），留空则自动生成 `data/secret.key` |
| `IWIKI_SECRET_SM2_PRIVATE_KEY` | 解密前端提交密钥（64 位 hex），留空则由 SM4 主密钥派生 |

> AI / RAG / Git 凭据**不再走环境变量**，统一在「平台管理」界面配置：前端 SM2 加密传输，后端 SM4 密文入库。

SSE 流式（AI 问答）要求 Nginx 配置 `proxy_buffering off`。

---

## 能力概览

| 能力 | 说明 |
|------|------|
| 多知识库空间 | 空间可作根知识库独立存在，也可挂在其他空间之下；支持迁移成根空间、迁移至空间、级联删除 |
| 文档编辑 | `SlMarkdownEditor` 所见即所得；本地草稿（浏览器自动保存）+ 云草稿（服务端暂存）两态 |
| 多人协作 | 保存时三路合并（node-diff3），冲突进专用页处理；版本快照 + gzip 增量 diff |
| 权限 | 公开 / 私密 / 指定成员；申请访问与审批 |
| 团队（用户组） | 加入模式（免审批 / 需审批 / 关闭）、邀请链接、申请审批；成员写权限按空间可配（可编辑 / 只读） |
| AI 问答 | RAG 检索有权限文档 + 流式输出；内置 DeepSeek，可扩展自定义 OpenAI 兼容 / vLLM 端点 |
| 演示文稿（PPT） | 复刻 WPS 基础操作：11 种版式、字体/字号/颜色/荧光笔/对齐、形状与文本框、图片上传、6 套模板、16:9 与 4:3、8 种切换效果、全屏放映；PPT 支持与富文档一致的多人协同（元素级 CRDT） |
| CodeWiki | 粘贴 Git 地址 → 自动探索仓库并生成 Wiki 树 |
| 界面 | 对标飞书云文档；目录树右键新建/迁移、树内拖拽排序；个人主页可选择正文字体 |

---

## 文档

| 文档 | 说明 |
|------|------|
| [文档中心](./docs/README.md) | 全部文档入口 |
| [平台介绍](./docs/平台介绍.md) | 产品定位、功能清单、架构、数据模型 |
| [部署指南](./docs/部署指南.md) | 编译、打包、上传、Nginx、Docker |
| [更新公告 2026-07-25](./docs/更新公告-2026-07-25.md) | 编辑器 + CodeWiki 拉取/探索上线说明 |
| [多人协作设计](./docs/多人协作设计.md) | 三路合并协同设计规格 |
| [多人协作实现说明](./docs/多人协作实现说明.md) | 三路合并协同实现细节 |
| [CodeWiki 原理与实现](./docs/CodeWiki原理与实现.md) | Git → 探索式 Agent → Wiki 流水线 |
| [API 参考](./docs/API参考.md) | REST / SSE 接口 |
| [前端架构](./docs/前端架构.md) | 前端分层、Store、编辑与冲突页 |
| [RAG 方案](./docs/rag方案.md) | AI 知识库检索 |
| [AI 编码使用规范](./docs/AI编码使用规范.md) | 全团队 AI 辅助编程约定 |
| [开发/运维备忘](./docs/notes/README.md) | 按日短注（空间删除、OAuth 端口、子域入口等） |