docs: add wecom syncer doc (#576)

casdoor · Oct 7, 2023 · 53e76a4 · 53e76a4
1 parent 24310bd
commit 53e76a4
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 0 deletions.
diff --git a/docs/syncer/WeCom.md b/docs/syncer/WeCom.md
@@ -0,0 +1,41 @@
+---
+title: WeCom
+description: Using WeCom Syncer to synchronize databases
+keywords: [syncer, database]
+authors: [UsherFall]
+---
+
+## WeCom Syncer
+
+By using WeCom syncer, you can sync WeCom user and department data to Casdoor's user table and group table.
+
+The following fields are required:
+
+- `Organization`: The organization that the user will be imported to
+- `Name`: The syncer's name
+- `Type`: Select "WeCom"
+- `User`: Your WeCom Company ID
+- `Password`: Your WeCom App secret
+- `ClientSecret`: Your WeCom Sync of Contacts secret
+
+Follow the steps below to configure.
+
+### Step 1: Get WeCom Syncer configuration items
+
+- In your WeCom management platform, navigate to **My Company**, get `Company ID` in **Company Information**.
+
+![wecom_corpid](/img/syncer/WeCom/syncer_wecom_corpid.png)
+
+- In your Self-build App, get `App secret`.
+
+![wecom_app](/img/syncer/WeCom/syncer_wecom_app.png)
+
+- In Sync of Contacts Management Tool, get `Sync of Contacts secret`.
+
+![wecom_contact](/img/syncer/WeCom/syncer_wecom_contact.png)
+
+### Step2: Config Casdoor WeCom Syncer
+
+Go to Syncers tab, select `WeCom` type and fill in the required information as shown below. Then, save the changes.
+
+![wecom_provider](/img/syncer/WeCom/syncer_wecom_provider.png)
diff --git a/sidebars.js b/sidebars.js
@@ -327,6 +327,7 @@ module.exports = {
         "syncer/overview",
         "syncer/Database",
         "syncer/Keycloak",
+        "syncer/WeCom",
       ],
     },
     {

diff --git a/static/img/syncer/WeCom/syncer_wecom_app.png b/static/img/syncer/WeCom/syncer_wecom_app.png
diff --git a/static/img/syncer/WeCom/syncer_wecom_contact.png b/static/img/syncer/WeCom/syncer_wecom_contact.png
diff --git a/static/img/syncer/WeCom/syncer_wecom_corpid.png b/static/img/syncer/WeCom/syncer_wecom_corpid.png
diff --git a/static/img/syncer/WeCom/syncer_wecom_provider.png b/static/img/syncer/WeCom/syncer_wecom_provider.png