diff --git a/docs/examples/index.md b/docs/examples/index.md new file mode 100644 index 00000000..bb0f7d7d --- /dev/null +++ b/docs/examples/index.md @@ -0,0 +1,6 @@ +# Examples + +Configuration examples for sing-box. + +* [Shadowsocks Server](./ss-server) +* [Shadowsocks Client](./ss-client) \ No newline at end of file diff --git a/docs/examples/ss-client.md b/docs/examples/ss-client.md new file mode 100644 index 00000000..0ca8a0c3 --- /dev/null +++ b/docs/examples/ss-client.md @@ -0,0 +1,23 @@ +# Shadowsocks Client + +```json +{ + "inbounds": [ + { + "type": "mixed", + "listen": "::", + "listen_port": 2080 + } + ], + "outbounds": [ + { + "type": "shadowsocks", + "server": "::", + "server_port": 8080, + "method": "2022-blake3-aes-128-gcm", + "password": "8JCsPssfgS8tiRwiMlhARg==" + } + ] +} + +``` \ No newline at end of file diff --git a/docs/examples/ss-server.md b/docs/examples/ss-server.md new file mode 100644 index 00000000..862e2bf9 --- /dev/null +++ b/docs/examples/ss-server.md @@ -0,0 +1,15 @@ +# Shadowsocks Server + +```json +{ + "inbounds": [ + { + "type": "shadowsocks", + "listen": "::", + "listen_port": 8080, + "method": "2022-blake3-aes-128-gcm", + "password": "8JCsPssfgS8tiRwiMlhARg==" + } + ] +} +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index df1987bc..5e56361b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -55,6 +55,10 @@ nav: - GeoIP: configuration/route/geoip.md - Geosite: configuration/route/geosite.md - Route Rule: configuration/route/rule.md + - Examples: + - examples/index.md + - Shadowsocks Server: examples/ss-server.md + - Shadowsocks Client: examples/ss-client.md markdown_extensions: - pymdownx.inlinehilite - pymdownx.snippets