Add route documentation

2022-07-08 20:15:45 +08:00
parent eeaee94e5e
commit 0cb9d79044
6 changed files with 250 additions and 1 deletions
--- a/docs/configuration/route/geosite.md
+++ b/docs/configuration/route/geosite.md
@@ -0,0 +1,35 @@
+# geosite
+
+### Structure
+
+```json
+{
+  "route": {
+    "geosite": {
+      "path": "",
+      "download_url": "",
+      "download_detour": ""
+    }
+  }
+}
+```
+
+### Fields
+
+#### path
+
+The path to the sing-geosite database.
+
+`geosite.db` will be used if empty.
+
+#### download_url
+
+The download URL of the sing-geoip database.
+
+Default is `https://github.com/SagerNet/sing-geosite/releases/latest/download/geosite.db`.
+
+#### download_detour
+
+The ag of the outbound to download the database.
+
+Default outbound will be used if empty.