add readme env

Author: wuxingzhang

.env.example

@@ -0,0 +1,2 @@
+ALLOWED_IPS=127.0.0.1,192.168.0.5
+PORT = 1080

README.md

@@ -1,2 +1,20 @@
 # go-socks-proxy
 Go-Socks-Proxy is a simple open-source project written in Go that allows you to connect to the internet through the SOCKS5 protocol. It's ideal for deployment on internal servers since it only handles IP whitelisting and doesn't implement encryption.
+
+## Installation
+1. Download the source code and navigate to the directory.
+2. Run `go build .` to compile the `go-socks-proxy` file.
+3. Configure the `ALLOWED_IPS` and `PORT` variables in the `.env` file.
+4. Run `nohup ./go-socks-proxy &` to start the server.
+
+## Usage
+Go-Socks-Proxy is easy to use. Simply configure your device's network settings to use the server's IP address and the port number you specified in the `.env` file.
+
+## Security
+Please note that Go-Socks-Proxy doesn't provide encryption, so it's not recommended to use it for sensitive data.
+
+## Contributions
+Contributions to the project are welcome. Feel free to fork the repository and submit a pull request.
+
+## License
+Go-Socks-Proxy is released under the MIT license. See `LICENSE` for more information.

go.mod

@@ -1,3 +1,5 @@
 module go-socks-proxy
 
 go 1.18
+
+require github.com/joho/godotenv v1.5.1 // indirect

go.sum

@@ -0,0 +1,2 @@
+github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
+github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=

main.go

@@ -9,7 +9,10 @@ import (
 	"io"
 	"log"
 	"net"
+	"os"
 	"strings"
+
+	"github.com/joho/godotenv"
 )
 
 const socks5Ver = 0x05
@@ -18,16 +21,27 @@ const atypIPV4 = 0x01
 const atypeHOST = 0x03
 const atypeIPV6 = 0x04
 
+func init() {
+	err := godotenv.Load()
+	if err != nil {
+		log.Fatalf("Error loading .env file: %v", err)
+	}
+}
+
 func main() {
+	// 获取 ALLOWED_IPS 环境变量的值
+	allowedIPsString := os.Getenv("ALLOWED_IPS")
+	// 将字符串以逗号分隔为切片
 	// 定义允许连接的 IP 地址
-	allowedIPs := []string{"127.0.0.1", "183.238.224.118", "110.40.194.189"}
+	allowedIPs := strings.Split(allowedIPsString, ",")
+	log.Printf("allowedIPs: %v", allowedIPs)
 
-	server, err := net.Listen("tcp", "0.0.0.0:1080")
+	server, err := net.Listen("tcp", "0.0.0.0:"+os.Getenv("PORT"))
 	if err != nil {
 		panic(err)
 	}
 	defer server.Close()
-	fmt.Println("Server started. Listening on :1080")
+	log.Println("Server started. Listening on :" + os.Getenv("PORT"))
 
 	for {
 		conn, err := server.Accept()
@@ -48,13 +62,13 @@ func main() {
 
 		// 如果客户端 IP 不在白名单中，关闭连接
 		if !allowed {
-			fmt.Println("Connection from", clientIP, "is not allowed")
+			// log.Println("Connection from", clientIP, "is not allowed")
 			conn.Close()
 			continue
 		}
 
 		// 处理客户端连接
-		fmt.Println("Connection from", clientIP, "is allowed")
+		log.Println("Connection from", clientIP, "is allowed")
 		go process(conn)
 	}
 }