This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Custom Sync Server

Language / 语言: English | 中文

---

English

In electerm sync panel, other than use github or gitee secret gist, could use a custom service to sync electerm data:

• API url: your-custom-web-service-url
• jwt secret: your jwt secret to verify request and extract user id
• user id: custom user id

• method: PUT, should store request body json data, get user id from jwtData.id
• method: GET, should return stored electerm sync data as json, get user id from jwtData.id
• method: POST, should return "ok", only when successfully get user id from jwtData.id

Check example sync service code:

• electerm-sync-server-cloudflare(recommanded): sync with free cloudflare worker and free cloudfalre D1 database
• electerm-sync-server-vercel
• electerm-sync-server-python
• electerm-sync-server-rust

中文

在 electerm 同步面板中，除了使用 GitHub 或 Gitee 秘密 gist，还可以使用自定义服务来同步 electerm 数据：

• API url: your-custom-web-service-url
• jwt secret: your jwt secret to verify request and extract user id
• user id: custom user id

• method: PUT, should store request body json data, get user id from jwtData.id
• method: GET, should return stored electerm sync data as json, get user id from jwtData.id
• method: POST, should return "ok", only when successfully get user id from jwtData.id

查看示例同步服务代码：

• electerm-sync-server-cloudflare(推荐): 使用免费的 cloudflare worker 和免费的 cloudflare D1 数据库同步
• electerm-sync-server-vercel
• electerm-sync-server-python
• electerm-sync-server-rust
• electerm-sync-server-node
• electerm-sync-server-cpp
• electerm-sync-server-java
• electerm-sync-server-kotlin
• electerm-sync-server-deno
• electerm-sync-server-go