Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hongkongkiwi/docker-shadowsocks-libev
Docker for setting up a shadowsocks-libev client or server (Private SOCKS5 Proxy).
https://github.com/hongkongkiwi/docker-shadowsocks-libev
docker proxy shadowsocks shadowsocks-libev
Last synced: 12 days ago
JSON representation
Docker for setting up a shadowsocks-libev client or server (Private SOCKS5 Proxy).
- Host: GitHub
- URL: https://github.com/hongkongkiwi/docker-shadowsocks-libev
- Owner: hongkongkiwi
- Created: 2017-06-15T15:20:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-06-17T03:33:37.000Z (over 7 years ago)
- Last Synced: 2025-01-11T18:08:48.704Z (13 days ago)
- Topics: docker, proxy, shadowsocks, shadowsocks-libev
- Language: Shell
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hongkongkiwi/docker-shadowsocks
Shadowsocks-libev is a lightweight secured SOCKS5 proxy for embedded devices and low-end boxes.
It is a port of Shadowsocks created by @clowwindy, and maintained by @madeye and @linusyang.
Shadowsocks-libev is written in pure C and depends on libev. It's designed to be a lightweight implementation of shadowsocks protocol, in order to keep the resource usage as low as possible.
For a full list of feature comparison between different versions of shadowsocks, refer to the Wiki page.
[](https://github.com/shadowsocks/shadowsocks-libev)
## Usage
### Creating a Server
```
docker create \
--name="shadowsocks-libev-server" \
--device="/dev/urandom" \
-v :/config/ss_config.json \
-e SS_MODE="server" \
-p 8080:8080 \
hongkongkiwi/shadowsocks-libev
```
### Creating a Client
```
docker create \
--name="shadowsocks-libev-client" \
--device="/dev/urandom" \
-v :/config/ss_config.json \
-e SS_MODE="client" \
-p 1080:1080 \
hongkongkiwi/shadowsocks-libev
```
### Testing the client
```
curl --socks5-hostname YOUR_SERVER_IP:1080 "http://www.google.com"
```
## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 1080:1090 would expose port 1080 from inside the container to be accessible from the host's IP on port 1090
http://192.168.x.x:1090 would show you what's running INSIDE the container on port 1080.`
* `-p 1080:1080` or `-p 8080:8080` - the port(s)
* `-v /config/ss_config.json` - location of configuration file
* `-e SS_MODE` for setting whether we are running as a server or client. Set to either "server" or "client"
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
* `-e TZ` for setting timezone information, eg Asia/Hong_Kong
It is based on a minimal alpine linux build, for shell access whilst the container is running do `docker exec -it "shadowsocks-libev-client" /bin/bash` or `docker exec -it "shadowsocks-libev-server" /bin/bash`.
### User / Group Identifiers
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
```
$ id
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
## Setting up the application
You will need to setup a config file to use for each kind of server. You can use some default settings as below:
### Server
```
{
"server": "0.0.0.0",
"server_port": 8080,
"local_address": "0.0.0.0",
"local_port":1080,
"password": "YOUR_PASSWORD",
"timeout": 300,
"method": "rc4-md5",
"fast_open": false
}
```
Note: Change YOUR_PASSWORD to whatever you want
### Client
```
{
"server": "YOUR_LOCAL_IP",
"server_port": 8080,
"local_address": "0.0.0.0",
"local_port":1080,
"password": "YOUR_PASSWORD",
"timeout": 300,
"method": "rc4-md5",
"fast_open": false
}
```
Note: Change YOUR_LOCAL_IP and YOUR_PASSWORD to whatever you want
## Info
* To monitor the logs of the container in realtime `docker logs -f "shadowsocks-libev-client"` or `docker logs -f "shadowsocks-libev-server"`.
## Versions
+ **16.06.17:** Initial Release