Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beraliv/socks5-server
Node server with support of SOCKS5 protocol
https://github.com/beraliv/socks5-server
node server socks-proxy socks-server socks5
Last synced: 12 days ago
JSON representation
Node server with support of SOCKS5 protocol
- Host: GitHub
- URL: https://github.com/beraliv/socks5-server
- Owner: Beraliv
- License: mit
- Created: 2018-04-13T12:02:42.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-28T06:59:52.000Z (almost 7 years ago)
- Last Synced: 2025-01-22T14:55:22.251Z (15 days ago)
- Topics: node, server, socks-proxy, socks-server, socks5
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# socks5-server
Node.js server supporting SOCKS5 protocol
- [x] call support
## Quick start
> You can use either `npm` or `yarn` to follow the instructions
1. Download Git repo:
```bash
git clone https://github.com/Beraliv/socks5-server
```
2. Download dependencies:
```bash
npm i
yarn
```
3. Start the server simply:
```bash
npm run start
yarn start
```
## Configurations
You need to configure both server and client
### Create server instance
1. Sign up to AWS (you can connect your card for $1 for the first year)
2. [Console](https://console.aws.amazon.com/ec2) > EC2 Dashboard > Launch instance
3. Ubuntu Server 16.04 LTS (HVM), SSD Volume Type > Select
4. t2.micro (Free tier eligible) > Next: Configure Instance Details
5. Next: Add Storage
6. Set Size (GiB) to `30` (maximum free available) > Next: Add Tags
7. Next: Configure Security
8. Add Type `Custom TCP Rule` with Port `1080` and Souce `Custom` with `0.0.0.0/0` for SOCKS5 > Review and Launch
9. Launch > Create a new key pair with Key pair name, i.e. `aws-keys` > Download Key Pair (it will download a private key with specified name, i.e. `aws-keys.pem`) > Launch Instances
### SSH access (Windows)
1. Install [PuTTY](https://putty.org.ru/download.html)
2. Install [WinSCP](https://winscp.net/eng/download.php)
3. WinSCP > Fill Host name with `IPv4 Public IP` from `Instances` in AWS Dashboard > Fill Port number with `22` for SSH > Fill User name with default for AWS `ubuntu`
4. Advanced > SSH > Authentication > Private key file > All private Keys Files > Choose `aws-keys.pem` > OK (convert to `.ppk`) > OK (Close Advanced Site Settings)
5. Save > Login
6. Use `Ctrl + P` for console
### Service
1. From [Quick Start](https://github.com/Beraliv/socks5-server#quick-start) download git repo and dependencies
2. Go to services directory with `cd /etc/systemd/system`
3. Create service for the server with `sudo touch s5ts.service`
4. Give write permissions to all users to the file with `sudo chmod 777 s5ts.service` and `sudo chown ubuntu s5ts.service`
5. Open file with Vim using `vim s5ts.service`
6. Insert (with right button of the mouse)
```
[Unit]
Description=Node server which supports SOCKS5 protocol
After=network.target
[Service]
ExecStart=/home/ubuntu/socks5-server/index.js
Restart=always
User=ubuntu
Group=nogroup
Environment=PATH=/usr/bin:/usr/local/bin
Environment=NODE_ENV=production
WorkingDirectory=/home/ubuntu/socks5-server
[Install]
WantedBy=multi-user.target
```
> Note RHEL/Fedora uses 'nobody', Debian/Ubuntu uses 'nogroup' as Group
7. `Esc` + `:wq!` will save and exit from Vim
8. To access `index.js` from created service, you need to add `sudo chmod 777 index.js` and `sudo chown ubuntu index.js` to `ExecStart` file
9. Make systemd aware of the new service with `sudo systemctl daemon-reload`
10. Make the service start on boot with `sudo systemctl enable s5ts`
### Service setups
1. To check logs in real time using `sudo journalctl --follow -u s5ts`
2. To restart service use `sudo systemctl restart s5ts`
## Windows Client
1. Find and open `C:\Windows\System32\drivers\etc\hosts`
2. Add a new line at the end: `$YOUR_IP_HERE$ $NAME$`, i.e. `173.21.33.95 s5ts.local`
3. Connect using specified settings:
or
