Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add wecom syncer doc #576

Merged
merged 1 commit into from
Oct 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/syncer/WeCom.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ module.exports = {
"syncer/overview",
"syncer/Database",
"syncer/Keycloak",
"syncer/WeCom",
],
},
{
Expand Down
Binary file added static/img/syncer/WeCom/syncer_wecom_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/syncer/WeCom/syncer_wecom_contact.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/syncer/WeCom/syncer_wecom_corpid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/syncer/WeCom/syncer_wecom_provider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading