Skip to content

Commit

Permalink
Preparing for merge with master branch
Browse files Browse the repository at this point in the history
  • Loading branch information
jgaa committed Mar 4, 2024
1 parent 454afdd commit 54d1f62
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ endif()
project(shinysocks
DESCRIPTION "Socks Proxy server"
HOMEPAGE_URL https://github.com/jgaa/shinysocks
VERSION 1.3.1
VERSION 1.3.2
LANGUAGES CXX
)

Expand Down
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ShinySOCKS

[![CI](https://github.com/jgaa/shinysocks/actions/workflows/ci.yaml/badge.svg?branch=fix-cmake)](https://github.com/jgaa/shinysocks/actions/workflows/ci.yaml)
[![CI](https://github.com/jgaa/shinysocks/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/jgaa/shinysocks/actions/workflows/ci.yaml)

## Mission Statement

Expand All @@ -24,12 +24,16 @@ therefore I'm spending a few hours writing my own.
- [My blog](https://lastviking.eu/_tags/shinysocks.html)

## Current State
The project is currently in maintenance mode. It just works.
The project has been in maintenance mode for ages. It just works.
However, these days I'm fixing some build issues to make it
simpler for you or other hackers to submit pull requests with new features ;)

I'm also in the process of updating the code from mostly C++11 to C++20.

The SOCKS server works for SOCKS 4, 4a and 5 under
Linux and Windows (compiled under Windows 7 with Visual
Studio 2015 RC and Boost 1.58). IPv6 and binding (reverse
connections) are not yet supported.
Linux Windows and MacOS.

IPv6 and binding (reverse connections) are not yet supported.

## How I use it

Expand All @@ -46,6 +50,14 @@ It simplifies things, and make my work-flow smooth. This also
improved my privacy, as the VPN host will only see the web traffic
going to the intranet sites.

## How I test it

If it run locally, and I have curl installed, I can test it like this:
```sh
curl -L --socks5-hostname socks5://localhost:1080 https://raw.githubusercontent.com/jgaa/shinysocks/master/ci/test.txt

```

## Docker

You can also pull a [Docker image](https://hub.docker.com/r/jgaafromnorth/shinysocks/)
Expand All @@ -62,7 +74,12 @@ docker run --rm --name shiny -p 1080:1080 -d jgaafromnorth/shinysocks

To test it on the command-line with `curl`:
```sh
curl -x socks5://localhost:1080 https://www.google.com/
# Let curl do the DNS lookup
curl -L -x socks5://localhost:1080 https://www.google.com/

# Let shinysocks do the DNS lookup

curl -L --socks5-hostname socks5://localhost:1080 https://www.google.com/
```

You can now set the socks 5 address to ip `127.0.0.1` port `1080` in your applications (for example Firefox') proxy settings and test it.
Expand Down

0 comments on commit 54d1f62

Please sign in to comment.