From 08c1e1b66b9f69c61c73e5b5d3f625ac346d227c Mon Sep 17 00:00:00 2001 From: Thomas Date: Mon, 20 May 2024 22:18:17 +1000 Subject: [PATCH] README: update for latest changes (#74) * document -q switch * update info on stack size * don't specify the exact stack size as it differs greatly depending on platform and C library * add a troubleshooting section on stack size segfaults --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cc5b9a3..65dab4c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ through them, if for some reason SSH doesn't cut it for you. It's very lightweight, and very light on resources too: -for every client, a thread with a stack size of 8KB is spawned. +for every client, a thread with a low stack size is spawned. the main process basically doesn't consume any resources at all. the only limits are the amount of file descriptors and the RAM. @@ -41,7 +41,7 @@ libc is not even 50 KB. that's easily usable even on the cheapest routers. command line options -------------------- - microsocks -1 -i listenip -p port -u user -P password -b bindaddr + microsocks -1 -q -i listenip -p port -u user -P password -b bindaddr all arguments are optional. by default listenip is 0.0.0.0 and port 1080. @@ -56,6 +56,7 @@ for example, authenticate once using curl: curl --socks5 user:password@listenip:port anyurl +option -q disables logging. Supported SOCKS5 Features ------------------------- @@ -63,3 +64,13 @@ Supported SOCKS5 Features - IPv4, IPv6, DNS - TCP (no UDP at this time) +Troubleshooting +--------------- + +if you experience segfaults, try raising the `THREAD_STACK_SIZE` in sockssrv.c +for your platform in steps of 4KB. + +if this fixes your issue please file a pull request. + +microsocks uses the smallest safe thread stack size to minimize overall memory +usage. -- 2.11.4.GIT