You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Docs/en-US/README.md
+17-22Lines changed: 17 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ This project provides scripts and configurations to automatically download and b
16
16
17
17
## **Project Background**
18
18
19
-
GeoIP databases are widely used in network security and traffic routing to determine IP location and assist with smart routing or access control. Many current projects rely on third-party distribution sources, which introduce potential risks:
19
+
GeoIP databases are widely used in network security and traffic policy routing to determine IP geolocation and assist with smart routing or access control. Many current projects rely on third-party distribution sources, which introduce potential risks:
20
20
21
21
-**Lack of trust chain**: Non-official sources cannot be audited and may be tampered with;
22
22
-**Poor maintainability**: Sources may become unavailable without notice;
@@ -28,7 +28,7 @@ To address these issues, this project implements a fully self-controlled update
28
28
29
29
-**Official Data Source:** All data is directly fetched from MaxMind, ensuring trust and security;
30
30
-**Automated Updates:** GitHub Actions pulls the latest data every 3 days to maintain synchronization;
31
-
-**License Compliance:** The project uses GitHub Actions to fetch MaxMind data in accordance with the [GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula). Users are advised to apply for their own License Key to ensure legal, secure, and traceable data usage.
31
+
-**License Compliance:** The project uses GitHub Actions to fetch MaxMind data in accordance with the [GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula). Users are strongly encouraged to apply for their own License Key to ensure legal, secure, and traceable data usage.
32
32
-**Customizable & Controllable:** Users can configure output paths, update frequency, target branches, and other parameters to suit their specific deployment needs.
33
33
34
34
### **Automated Updates**
@@ -51,33 +51,28 @@ Copy the file URL → Open Surge → Go to General → GeoIP Database → Remove
51
51
52
52
## **⚠️ Important Notes**
53
53
54
-
1.**Disable or remove any rules related to CN IP ranges:**
54
+
1.**In this project, only manual commits (made by real developers) are signed with a GPG key.**
55
55
56
-
```
57
-
RULE-SET,https://raw.githubusercontent.com/Thoseyearsbrian/Aegis/main/SurgeAegis/rules/China.list,DIRECT # Remove this
58
-
GEOIP,CN,DIRECT # Also avoid using this with the above line
59
-
```
56
+
Automated updates (such as GeoLite2 database updates) are executed via GitHub Actions and **do not use GPG signatures**. Please verify the committer as [`github-actions[bot]`](https://github.com/apps/github-actions) to consider the commit valid and trustworthy.
60
57
61
-
2.The GEOIP,CN,DIRECT rule should be placed **just above the final rule** to ensure correct evaluation order:
58
+
- Manual commits are still GPG-signed to identify the authentic developer
59
+
- We do **not recommend** storing any GPG private keys on GitHub to prevent key leakage and signature abuse
62
60
63
-
```
64
-
# ... other rules ...
65
-
GEOIP,CN,DIRECT # Place here
66
-
FINAL,REJECT
67
-
```
61
+
2.**It is recommended to combine `China.list` (for domains) with `GEOIP,CN` (for IP ranges) to improve accuracy when matching China-related traffic:**
68
62
69
-
3.Do **not use GEOIP rules for countries other than China, as this database only contains **China mainland IP segments**:
63
+
RULE-SET,https://raw.githubusercontent.com/Thoseyearsbrian/Aegis/main/rules/China.list, DIRECT # Accurately match domains related to China
64
+
GEOIP,CN,DIRECT # Match mainland China IPs not covered by domain rules
65
+
FINAL,REJECT # Final default reject rule (do not place GEOIP below this)
70
66
71
-
```
72
-
GEOIP,US,PROXY # Incorrect – will not match
73
-
GEOIP,AU,PROXY # Incorrect – will not match
74
-
GEOIP,HK,PROXY # Incorrect – will not match
75
-
GEOIP,CN,DIRECT # Correct
76
-
```
67
+
3.**Do not use GEOIP rules for countries other than mainland China, as the current database only contains CN IP ranges:**
68
+
69
+
GEOIP, US, PROXY # Invalid – No matching records found
70
+
GEOIP, AU, PROXY # Invalid – No matching records found
71
+
GEOIP, CN, DIRECT # Valid
77
72
78
73
## **🔐 Disclaimer**
79
74
80
-
The .mmdb file generated by this project is intended **for testing and educational purposes only**. It must **not be used for any form of commercial use**.
75
+
The .mmdb file generated by this project is intended **for testing and educational purposes only**. It must **not be used in any form of commercial activity**.
81
76
82
77
Users are solely responsible for ensuring compliance with the [MaxMind GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula) and applicable laws and regulations. **This project accepts no legal liability for any use of the data.**
83
78
@@ -91,4 +86,4 @@ This project is **intended for developers with a technical background and awaren
91
86
92
87
- This project uses GitHub Actions to automatically pull data from MaxMind. **You must register on MaxMind and obtain your own License Key** to run the build script or automation legally.
93
88
- GeoLite2 data is copyrighted by [MaxMind, Inc.](https://www.maxmind.com/) and is licensed under the [GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula).
94
-
- All scripts and configurations in this project are released under the [MIT License](https://raw.githubusercontent.com/Thoseyearsbrian/GeoIP2-CN/main/LICENSE).
89
+
- All scripts and configuration files in this project are licensed under the [Apache License 2.0](https://raw.githubusercontent.com/Thoseyearsbrian/GeoIP2-CN/main/LICENSE).
Copy file name to clipboardExpand all lines: README.md
+17-22Lines changed: 17 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ This project provides scripts and configurations to automatically download and b
16
16
17
17
## **Project Background**
18
18
19
-
GeoIP databases are widely used in network security and traffic routing to determine IP location and assist with smart routing or access control. Many current projects rely on third-party distribution sources, which introduce potential risks:
19
+
GeoIP databases are widely used in network security and traffic policy routing to determine IP geolocation and assist with smart routing or access control. Many current projects rely on third-party distribution sources, which introduce potential risks:
20
20
21
21
-**Lack of trust chain**: Non-official sources cannot be audited and may be tampered with;
22
22
-**Poor maintainability**: Sources may become unavailable without notice;
@@ -28,7 +28,7 @@ To address these issues, this project implements a fully self-controlled update
28
28
29
29
-**Official Data Source:** All data is directly fetched from MaxMind, ensuring trust and security;
30
30
-**Automated Updates:** GitHub Actions pulls the latest data every 3 days to maintain synchronization;
31
-
-**License Compliance:** The project uses GitHub Actions to fetch MaxMind data in accordance with the [GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula). Users are advised to apply for their own License Key to ensure legal, secure, and traceable data usage.
31
+
-**License Compliance:** The project uses GitHub Actions to fetch MaxMind data in accordance with the [GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula). Users are strongly encouraged to apply for their own License Key to ensure legal, secure, and traceable data usage.
32
32
-**Customizable & Controllable:** Users can configure output paths, update frequency, target branches, and other parameters to suit their specific deployment needs.
33
33
34
34
### **Automated Updates**
@@ -51,33 +51,28 @@ Copy the file URL → Open Surge → Go to General → GeoIP Database → Remove
51
51
52
52
## **⚠️ Important Notes**
53
53
54
-
1.**Disable or remove any rules related to CN IP ranges:**
54
+
1.**In this project, only manual commits (made by real developers) are signed with a GPG key.**
55
55
56
-
```
57
-
RULE-SET,https://raw.githubusercontent.com/Thoseyearsbrian/Aegis/main/SurgeAegis/rules/China.list,DIRECT # Remove this
58
-
GEOIP,CN,DIRECT # Also avoid using this with the above line
59
-
```
56
+
Automated updates (such as GeoLite2 database updates) are executed via GitHub Actions and **do not use GPG signatures**. Please verify the committer as [`github-actions[bot]`](https://github.com/apps/github-actions) to consider the commit valid and trustworthy.
60
57
61
-
2.The GEOIP,CN,DIRECT rule should be placed **just above the final rule** to ensure correct evaluation order:
58
+
- Manual commits are still GPG-signed to identify the authentic developer
59
+
- We do **not recommend** storing any GPG private keys on GitHub to prevent key leakage and signature abuse
62
60
63
-
```
64
-
# ... other rules ...
65
-
GEOIP,CN,DIRECT # Place here
66
-
FINAL,REJECT
67
-
```
61
+
2.**It is recommended to combine `China.list` (for domains) with `GEOIP,CN` (for IP ranges) to improve accuracy when matching China-related traffic:**
68
62
69
-
3.Do **not use GEOIP rules for countries other than China, as this database only contains **China mainland IP segments**:
63
+
RULE-SET,https://raw.githubusercontent.com/Thoseyearsbrian/Aegis/main/rules/China.list, DIRECT # Accurately match domains related to China
64
+
GEOIP,CN,DIRECT # Match mainland China IPs not covered by domain rules
65
+
FINAL,REJECT # Final default reject rule (do not place GEOIP below this)
70
66
71
-
```
72
-
GEOIP,US,PROXY # Incorrect – will not match
73
-
GEOIP,AU,PROXY # Incorrect – will not match
74
-
GEOIP,HK,PROXY # Incorrect – will not match
75
-
GEOIP,CN,DIRECT # Correct
76
-
```
67
+
3.**Do not use GEOIP rules for countries other than mainland China, as the current database only contains CN IP ranges:**
68
+
69
+
GEOIP, US, PROXY # Invalid – No matching records found
70
+
GEOIP, AU, PROXY # Invalid – No matching records found
71
+
GEOIP, CN, DIRECT # Valid
77
72
78
73
## **🔐 Disclaimer**
79
74
80
-
The .mmdb file generated by this project is intended **for testing and educational purposes only**. It must **not be used for any form of commercial use**.
75
+
The .mmdb file generated by this project is intended **for testing and educational purposes only**. It must **not be used in any form of commercial activity**.
81
76
82
77
Users are solely responsible for ensuring compliance with the [MaxMind GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula) and applicable laws and regulations. **This project accepts no legal liability for any use of the data.**
83
78
@@ -91,4 +86,4 @@ This project is **intended for developers with a technical background and awaren
91
86
92
87
- This project uses GitHub Actions to automatically pull data from MaxMind. **You must register on MaxMind and obtain your own License Key** to run the build script or automation legally.
93
88
- GeoLite2 data is copyrighted by [MaxMind, Inc.](https://www.maxmind.com/) and is licensed under the [GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula).
94
-
- All scripts and configurations in this project are released under the [MIT License](https://raw.githubusercontent.com/Thoseyearsbrian/GeoIP2-CN/main/LICENSE).
89
+
- All scripts and configuration files in this project are licensed under the [Apache License 2.0](https://raw.githubusercontent.com/Thoseyearsbrian/GeoIP2-CN/main/LICENSE).
0 commit comments