Skip to content

Commit 75f771a

Browse files
committed
docs: add docs for the new feature of ip whitelist.
1 parent 87fe115 commit 75f771a

File tree

6 files changed

+48
-0
lines changed

6 files changed

+48
-0
lines changed

docs/ip-whitelist/ip-whitelist.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Overview
3+
description: Support IP limitation for user entry pages.
4+
keywords: [ip, whitelist, ip whitelist]
5+
authors: [ZhaoYP-2001]
6+
---
7+
8+
Casdoor supports the ip whitelist function of the entry page. When a user accesses the entry page (login/signup/forget-password), Casdoor will decide whether to allow the user to access the entry page based on whether the client IP is in the whitelist. Here, we will show you how to enable the option to specify the ip whitelist function of the entry page at the organization, application and user levels.
9+
10+
## Configuration
11+
12+
### User Level
13+
14+
Casdoor will first determine whether the client address meets the user-level ip whitelist requirements.
15+
16+
If you want to specify user-level ip whitelist, you first need to add the "IP whitelist" account item on the edit page of the organization to which the user belongs. Then specify your ip whitelist by filling in the comma separated CIDR list, such as 192.168.1.0/24,25.112.0.0/16. If the ip whitelist is empty, it means there is no restriction on the client IP address.
17+
18+
![user_ip_whitelist](/img/ip-whitelist/user_ip_whitelist.png)
19+
20+
:::info
21+
22+
If you forget how to customize users' **account items**, Please refer to the **[Account Customization](organization/accountCustomization.md)**
23+
24+
:::
25+
26+
### Application Level
27+
28+
If the client IP address passes the organization-level check, Casdoor will proceed to perform application-level check. You can specify the ip whitelist through the `IP whitelist` configuration option on the application edit page.
29+
30+
![app_ip_whitelist](/img/ip-whitelist/app_ip_whitelist.png)
31+
32+
### Organization Level
33+
34+
Organization-level check will be performed last. You can use the `IP whitelist` configuration option to specify organization-level ip whitelist.
35+
36+
![org_ip_whitelist](/img/ip-whitelist/org_ip_whitelist.png)
37+
38+
Here is a demo video that shows how to use ip whitelist:
39+
40+
<video src="/img/ip-whitelist/ip_whitelist.mp4" controls="controls" width="100%"></video>

sidebars.js

+8
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,14 @@ module.exports = {
343343
"invitation/overview",
344344
],
345345
},
346+
{
347+
type: "category",
348+
label: "IP Whitelist",
349+
link: {type: "generated-index"},
350+
items: [
351+
"ip-whitelist/ip-whitelist",
352+
],
353+
},
346354
{
347355
type: "category",
348356
label: "Syncer",
4.5 KB
Loading
62.1 MB
Binary file not shown.
4.76 KB
Loading
5.58 KB
Loading

0 commit comments

Comments
 (0)