Add changelog and readme files
This commit is contained in:
parent
e321695d0c
commit
803767b6f7
15
Changelog.md
Normal file
15
Changelog.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# Changelog
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [v0.0.1] - 2018-04-24
|
||||||
|
### Added
|
||||||
|
- Optional auth
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Golang vendoring
|
||||||
|
- Change Dockerfile for multistage builds with final scratch image
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
- IDE files
|
24
README.md
24
README.md
@ -2,10 +2,24 @@
|
|||||||
|
|
||||||
Simple socks5 server using go-socks5 with or without auth.
|
Simple socks5 server using go-socks5 with or without auth.
|
||||||
|
|
||||||
# Start container with proxy
|
## Start container with proxy
|
||||||
```docker run -d --name socks5 -p 1080:1080 -e PROXY_USER=<PROXY_USER> -e PROXY_PASSWORD=<PROXY_PASSWORD> olebedev/socks5```
|
|
||||||
|
|
||||||
For auth-less mode just do not pass `PROXY_USER` and `PROXY_PASSWORD`.
|
```docker run -d --name socks5 -p 1080:1080 -e PROXY_USER=<PROXY_USER> -e PROXY_PASSWORD=<PROXY_PASSWORD> serjs/go-socks5-proxy```
|
||||||
|
|
||||||
# Test running service
|
For auth-less mode just do not pass envrionment variables `PROXY_USER` and `PROXY_PASSWORD`.
|
||||||
```curl --socks5 <docker machine ip>:1080 https://ya.ru``` - result must show docker host ip (for bridged network)
|
|
||||||
|
## Test running service
|
||||||
|
|
||||||
|
Without auth
|
||||||
|
|
||||||
|
```curl --socks5 <docker host ip>:1080 http://ifcfg.co``` - result must show docker host ip (for bridged network)
|
||||||
|
|
||||||
|
With auth
|
||||||
|
|
||||||
|
```curl --socks5 --user <PROXY_USER:<PROXY_PASSWORD> <docker host ip>:1080 http://ifcfg.co``` - result must show docker host ip (for bridged network)
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
|
||||||
|
* **Sergey Bogayrets**
|
||||||
|
|
||||||
|
See also the list of [contributors](https://github.com/serjs/socks5-server/graphs/contributors) who participated in this project.
|
||||||
|
Loading…
Reference in New Issue
Block a user