netlify.toml Documentation

1. Project Overview & Quickstart (openimsdk/netlify.toml) Copy Chapter

netlify.toml

Open-source repository openimsdk/netlify.toml

Repository Details Copy Section

• Repository: openimsdk/netlify.toml
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (openimsdk/docs) Copy Chapter

File: README.md Copy Chapter

OpenIMSDK Documentation

This repository contains the source for the official OpenIMSDK documentation. It provides implementation guides and API documentation for OpenIMClientSDK, OpenIMServer, ChatServer, and the server-side Platform API in English and Simplified Chinese.

OpenIMSDK is the umbrella project for the OpenIMClientSDK client SDKs and the OpenIMServer core IM server. ChatServer is the business extension server; it is not presented as a standalone “Chat” product. The source repositories are maintained by the OpenIMSDK organization.

Documentation links Copy Chapter

Documentation scope Copy Chapter

The public documentation currently covers:

• OpenIMSDK concepts, OpenIMServer and ChatServer deployment guidance, and integration workflows
• iOS SDK
• Flutter SDK
• Electron SDK
• JavaScript SDK for lightweight Web and Mini Program runtimes
• JavaScript SDK (WASM) for full Web IM applications and Electron renderer processes
• Platform API, including authentication, users, relationships, groups, conversations, messages, Webhooks, and operational APIs

Only reviewed platforms and pages appear in the public navigation, search index, and sitemap. Draft structures for additional platforms may remain in the repository without being published.

Capabilities marked Enterprise require the corresponding commercial edition or delivery. See the Enterprise edition for product information, or contact [email protected] for licensing and commercial support.

Technology Copy Chapter

The documentation application is built with:

• Next.js and React
• Fumadocs for MDX content integration
• TypeScript
• Tailwind CSS
• pnpm and Corepack

English and Simplified Chinese pages share one audited route structure. Navigation, search indexes, localized SDK packages, and publication metadata are derived from reviewed MDX and structural records.

Local development Copy Chapter

Requirements Copy Section

• Node.js 22.12 or later
• Corepack
• The pnpm version declared in package.json

Start the development server Copy Section

corepack enable
pnpm install --frozen-lockfile
cp .env.example .env.local
pnpm dev

Open the local site at:

• English: http://localhost:3000
• Simplified Chinese: http://localhost:3000/zh

Repository structure Copy Chapter

api/chat/platform-api/  Versioned OpenAPI source documents
app/                    Next.js routes, metadata, search, and sitemap
content/docs/           English SDK and Platform API MDX
content/en/docs/guides/ Reviewed English guide snapshots
content/zh/docs/        Simplified Chinese MDX and guide snapshots
data/structure/         Navigation, ownership, scope, and review records
docs/                   Current architecture and authoring documentation
public/                 Versioned images, brand assets, and downloads
scripts/                Active validation, synchronization, and build tools
src/components/         Documentation and site UI
src/generated/          Committed route, navigation, search, and locale data

Public URLs do not expose internal product-version directories. For example:

/sdk/wasm/overview
└── content/docs/chat/sdk/wasm/overview.mdx

/zh/sdk/wasm/overview
└── content/zh/docs/chat/sdk/wasm/overview.mdx

Generated files are build inputs, not editorial evidence. Documentation facts must be verified against the pinned OpenIMClientSDK declarations, OpenIMServer definitions, OpenAPI documents, or the immutable sources recorded in the relevant audit file.

Authoring and localization Copy Chapter

Read CONTRIBUTING.md and the content authoring guide before changing documentation pages.

The client SDK localization workflow is Chinese-first:

1. Review the complete Simplified Chinese page and its technical evidence.
2. Edit and audit the page manually.
3. Translate the reviewed page into fluent English.
4. Verify API names, parameters, examples, results, events, and links against the target SDK.
5. Publish the English route only after its review record is complete.

Final MDX prose must be reviewed page by page. Scripts may update deterministic structure and generated metadata, but they must not generate or machine-translate final documentation text.

Validation Copy Chapter

Run the complete validation suite before submitting or publishing changes:

pnpm check
pnpm build

pnpm check includes linting, TypeScript validation, content integrity checks, SDK publication audits, example checks, OpenAPI linting, and Platform API tests. pnpm build validates the production application. Local and Docker builds also prepare the standalone server output; managed platforms use their own Next.js runtime.

Frequently used commands:

Configuration Copy Chapter

Copy .env.example to .env.local for local development. The following public environment variables configure canonical URLs and external navigation:

NEXT_PUBLIC_SITE_URL=https://docs.openim.io
NEXT_PUBLIC_WEBSITE_URL=https://openim.io/
NEXT_PUBLIC_ENTERPRISE_URL=https://openim.io/enterprise/
NEXT_PUBLIC_LEGACY_DOCS_URL=https://openim-docs-legacy.vercel.app
NEXT_PUBLIC_GITHUB_URL=https://github.com/openimsdk
NEXT_PUBLIC_EDIT_BASE_URL=https://github.com/openimsdk/docs/edit/main

NEXT_PUBLIC_LEGACY_DOCS_URL controls the archived-documentation link in the global navigation. Leave NEXT_PUBLIC_EDIT_BASE_URL empty if edit links should not be displayed.

Deployment Copy Chapter

Netlify Copy Section

The production site at docs.openim.io is deployed from main through Netlify. netlify.toml fixes the build command, publish directory, Node.js version, and Next.js Runtime in version control.

Every production deployment must reach ready and pass smoke tests for the home pages, SDK and Platform API routes, search, redirects, Sitemap, and Robots. See the deployment audit for the verified production chain.

Vercel Copy Section

The repository includes vercel.json. Configure the production environment variables, import the repository into Vercel, and use the committed pnpm lockfile. Vercel runs:

pnpm install --frozen-lockfile
pnpm build

Docker and standalone Node.js Copy Section

Build and run the maintained container image with:

docker compose up --build

For a direct Node.js deployment:

corepack enable
pnpm install --frozen-lockfile
pnpm build
PORT=3000 HOSTNAME=0.0.0.0 pnpm start

The production server is generated at .next/standalone/server.js.

Contributing Copy Chapter

Contributions that improve correctness, examples, navigation, accessibility, or developer experience are welcome. Pull requests should identify the affected documentation area, the SDK or server evidence used, and the validation commands that were run.

See:

• Contribution guide
• Content authoring rules
• Architecture
• Current publication scope

Support and security Copy Chapter

Use GitHub Issues for reproducible documentation defects and content corrections. For product, deployment, licensing, or commercial support, contact [email protected].

Do not report security vulnerabilities in a public issue. Follow the private reporting process in SECURITY.md.

License Copy Chapter

This documentation project is licensed under the MIT License.

File: content/zh/docs/chat/sdk/electron/message/create-media-from-full-path.mdx Copy Chapter

title: '从完整路径创建媒体消息' sourcePath: '/sdk/electron/message/create-media-from-full-path' Copy Chapter

Electron FFI 提供一组从本地完整文件路径创建媒体消息的 API。它们适合桌面端已经拿到磁盘绝对路径的场景，例如系统文件选择器返回的路径。浏览器与 Electron WASM 形态应使用对应的 *ByFile / *ByURL 方法；以图片为例，分别见使用文件创建图片消息和使用 URL 创建图片消息。需要独立上传文件时，见上传文件。

创建得到 MessageItem 后，发送步骤与共享消息模型相同，调用 sendMessage()；发送参数与事件见发送消息。

支持的方法 Copy Chapter

这些方法只创建消息对象，不会自动发送，也不会触发新消息事件。

图片消息 Copy Chapter

createImageMessageFromFullPath() 直接接收图片文件的绝对路径字符串。

const { data: message } = await openimsdk.createImageMessageFromFullPath(
  '/absolute/path/to/photo.jpg',
);

await openimsdk.sendMessage({
  recvID,
  groupID: '',
  message,
});

语音消息 Copy Chapter

参数说明 Copy Section

const { data: message } = await openimsdk.createSoundMessageFromFullPath({
  soundPath: '/absolute/path/to/voice.m4a',
  duration: 3200,
});

视频消息 Copy Chapter

参数说明 Copy Section

const { data: message } = await openimsdk.createVideoMessageFromFullPath({
  videoPath: '/absolute/path/to/clip.mp4',
  videoType: 'mp4',
  duration: 12000,
  snapshotPath: '/absolute/path/to/cover.jpg',
});

文件消息 Copy Chapter

参数说明 Copy Section

const { data: message } = await openimsdk.createFileMessageFromFullPath({
  filePath: '/absolute/path/to/report.pdf',
  fileName: 'report.pdf',
});

调用结果 Copy Chapter

四个 *FromFullPath 方法的 Promise 成功后，data 都是待发送的 MessageItem。随后的 sendMessage() Promise 成功只代表发送请求完成；对端是否收到消息，以其客户端收到的新消息事件为准。

相关页面 Copy Chapter

• Electron SDK 概览
• 发送消息
• 上传文件

File: content/zh/docs/chat/sdk/electron/logger/upload-logs.mdx Copy Chapter

title: '上传日志' sourcePath: '/sdk/electron/logger/upload-logs' Copy Chapter

Electron FFI 提供 uploadLogs()，用于把原生侧已落盘的诊断日志上传到当前 OpenIMServer 配置的日志收集链路。浏览器侧的日志配置见 WASM 日志；WASM 包不提供对等的 uploadLogs()。

只在排查问题、用户主动提交诊断信息或运维要求时上传。上传前确认日志中不包含 Token、消息正文或其他敏感字段；需要补充业务上下文时，使用 ex 写入可公开的诊断标记，不要写入凭据。

上传日志 Copy Chapter

参数说明 Copy Section

await openimsdk.uploadLogs({
  line: 2000,
  ex: 'desktop-diag-session',
});

调用结果 Copy Chapter

uploadLogs() 的 Promise 成功表示本次上传请求已完成。它不会修改会话、消息或用户资料，也不会触发业务领域事件。上传失败时记录 errCode、errMsg 和当前用户 ID，便于与 OpenIMServer 侧日志对应；不要在失败日志中再次输出完整日志正文。

相关页面 Copy Chapter

• Electron SDK 概览
• WASM 日志
• 认证与初始化

File: content/zh/docs/chat/sdk/electron/getting-started/authenticate-and-init.mdx Copy Chapter

title: '认证与初始化' sourcePath: '/sdk/electron/getting-started/authenticate-and-init' Copy Chapter

Electron FFI 形态把 SDK 初始化与用户登录拆开：先用 initSDK() 配置 OpenIMServer 地址和本地运行目录，再用 login() 提交 userID 与 Token。这与 WASM 认证与管理登录会话 中一次性传入 InitAndLoginConfig 的写法不同。

本页只覆盖 Electron FFI 的生命周期 API。连接成功、Token 失效和踢下线等事件的处理边界可参考 WASM 认证页；实际注册时应使用当前 Electron FFI SDK 提供的事件枚举，不要直接复制 WASM 的 SdkEvent 类型。

与 WASM 的差异 Copy Chapter

Electron 渲染层如果走 WASM 形态，请直接按 WASM 认证页接入，不要调用本页的 initSDK()。

初始化 SDK Copy Chapter

InitConfig 在初始化时写入服务地址、平台、本地数据目录和日志选项。

参数说明 Copy Section

await openimsdk.initSDK({
  apiAddr,
  wsAddr,
  platformID,
  dataDir: '/absolute/path/to/openim-data',
  systemType: 'electron',
  logLevel: LogLevel.Warn,
  isLogStandardOutput: false,
});

initSDK() 的 Promise 成功表示原生 SDK 已完成初始化并可以继续登录；它不会建立用户会话，也不等于连接事件已到达。

登录当前用户 Copy Chapter

初始化成功后再调用 login()。FFI 登录只接收用户凭据：

参数说明 Copy Section

await openimsdk.login({
  userID,
  token,
});

login() 的 Promise 成功表示登录请求完成；是否已可调用业务 API，仍应结合 OnConnectSuccess 等连接事件判断。事件注册方式见 WASM 认证页。

退出与卸载 Copy Chapter

用户主动退出或切换账号时，先调用共享的 logout() 结束登录会话，再在需要释放原生资源时调用 unInitSDK()。

await openimsdk.logout();
await openimsdk.unInitSDK();

unInitSDK() 不接收业务参数。切换账号时，先完成旧账号退出与状态清理，再按需重新 initSDK() 并 login()；不要并发初始化两个原生实例。

下一步 Copy Chapter

• Electron SDK 概览
• WASM 认证与管理登录会话
• 从完整路径创建媒体消息

File: content/zh/docs/chat/sdk/electron/overview.mdx Copy Chapter

title: 'OpenIM Electron SDK 概览' sourcePath: '/sdk/electron/overview' Copy Chapter

Electron SDK 同时提供 WASM 和 FFI 两种接入形态。共享的用户、会话、群组、消息、通话和事件能力以 WASM SDK 文档 为准；本页只说明形态选择，以及 FFI 形态相对 WASM 多出的 API 与登录参数差异。

SDK 形态分工 Copy Chapter

接入差异（仅 FFI） Copy Chapter

WASM 浏览器包通过一次 login(InitAndLoginConfig) 同时传入服务地址、平台和用户凭据。Electron FFI 拆成两步：

1. initSDK(InitConfig)：写入 apiAddr、wsAddr、platformID、dataDir、systemType 和日志选项。
2. login({ userID, token })：只提交当前用户凭据。

完整参数、示例和 unInitSDK() 见认证与初始化。共享的连接、Token 和踢下线事件监听仍参考 WASM 认证与管理登录会话。

Electron 专属 API（FFI） Copy Chapter

浏览器或 Electron WASM 形态不要调用这些 FFI 专用方法；媒体消息应继续使用 WASM 文档中的 *ByFile / *ByURL 路径。

共享能力（链到 WASM） Copy Chapter

桌面端注意事项 Copy Chapter

• 同时覆盖 Web 与 Electron 时，先定义应用内 IM 适配器，再按环境选择 WASM 或 FFI。
• 使用 WASM 形态时，打包后仍需验证 openIM.wasm、sql-wasm.wasm 和 wasm_exec.js 可访问。
• 使用 FFI 形态时，按桌面安装包、权限、dataDir 和升级策略接入，不要套用浏览器 WASM 资源路径。
• 主进程与渲染进程都需要 IM 状态时，先明确 IPC 边界和会话所有权，避免多实例竞争。
• 不要把用户 Token 写入 preload 脚本或主进程日志。

File: content/zh/docs/chat/sdk/flutter/group/group-applications/accept-group-application.mdx Copy Chapter

title: '接受入群申请' sourcePath: '/sdk/flutter/group/group-applications/accept-group-application' Copy Chapter

传入有效的 groupID、申请人 userID 和可选 handleMsg。Future 成功表示服务端完成处理请求，不应直接伪造成员记录。

await OpenIM.iMManager.groupManager.acceptGroupApplication(
  groupID: groupID,
  userID: applicantUserID,
  handleMsg: '欢迎加入',
);

File: content/zh/docs/chat/sdk/flutter/group/group-applications/get-group-application-list-as-applicant.mdx Copy Chapter

title: '获取发出的入群申请' sourcePath: '/sdk/flutter/group/group-applications/get-group-application-list-as-applicant' Copy Chapter

传入 GetGroupApplicationListAsApplicantReq。Future 成功返回当前用户发出的申请；查询方向与收到的申请不同，分页字段含义相同。

final applications = await OpenIM.iMManager.groupManager
    .getGroupApplicationListAsApplicant(
  GetGroupApplicationListAsApplicantReq(
    groupIDs: [groupID],
    handleResults: [0],
    offset: 0,
    count: 20,
  ),
);

File: content/zh/docs/chat/sdk/flutter/group/group-applications/get-group-application-list-as-recipient.mdx Copy Chapter

title: '获取收到的入群申请' sourcePath: '/sdk/flutter/group/group-applications/get-group-application-list-as-recipient' Copy Chapter

传入 GetGroupApplicationListAsRecipientReq，设置 groupIDs、handleResults、offset 和 count。Future 成功返回当前用户有权处理的 List<GroupApplicationInfo>。

final applications = await OpenIM.iMManager.groupManager
    .getGroupApplicationListAsRecipient(
  GetGroupApplicationListAsRecipientReq(
    groupIDs: [groupID],
    handleResults: [0],
    offset: 0,
    count: 20,
  ),
);

File: content/zh/docs/chat/sdk/flutter/group/group-applications/get-group-application-unhandled-count.mdx Copy Chapter

title: '获取未处理入群申请数' sourcePath: '/sdk/flutter/group/group-applications/get-group-application-unhandled-count' Copy Chapter

final count = await OpenIM.iMManager.groupManager
    .getGroupApplicationUnhandledCount(
  GetGroupApplicationUnhandledCountReq(time: 0),
);

查询只返回调用时的未处理数量，不改变申请状态。

File: content/zh/docs/chat/sdk/flutter/group/group-applications/overview-group-applications.mdx Copy Chapter

title: '入群申请概览' sourcePath: '/sdk/flutter/group/group-applications/overview-group-applications' Copy Chapter

固定 Flutter SDK 提供收到/发出申请、未处理数量、同意和拒绝五个方法，没有角标读取、角标清除或删除申请记录方法。

申请事件通过应用唯一的 OnGroupListener 处理，按 groupID:userID 合并；分页期间发生变化时重置分页。