node-red-contrib-telegrambot/SOCKS5.md

Telegram bot nodes for Node-RED

# Socks5 Documentation
You can enable SOCKS proxy support if you want to re-route your calls to the telegram bot api server (api.telergam.org) via an anonymous server.

If the proxy server requires authentication you need to provide a username and password. If not, the fields must be empty:
<img src="images/TelegramBotSocks5Configuration.png" title="Socks5 configuration without user and password" width="600" />

# General Notes
- The default port for socks5 is 1080.
- As the underlying request lib pools the agent, you need to restart node red when changing IP or the PORT. 

# Finding a SOCKS proxy
## Internet
You can google for free socks5 proxy in the internet to find one, however this is not recommended as you do not know who
is able to intercept your calls to the telegram bot server. Traffic between you and the telegram server is done using the https protocol, but that is not 100% safe. You can also pay a provider of your choice for a socks5 instance running in the internet but the best choice is to set up your own one.

## Localhost (ssh)
You can set up your own server for testing in your local network as follows:
https://catonmat.net/linux-socks5-proxy

## Local network (socks5-server)
An easy way to set up your own server is creating a docker container using socks5-server which is available here:
https://github.com/serjs/socks5-server

### Example using QNAP Container Station

#### 1. Open Container Station and Select "Create" from the menu and search for "serjs/go-socks5-proxy" and install the package.
<img src="images/TelegramBotSocks5Docker1.png" title="socks5-server via docker hub" width="600" />
The image in the screenshot is already downloaded but can be found under the tab "Docker Hub"
See also https://hub.docker.com/r/serjs/go-socks5-proxy/


#### 2. Select Advanced Settings 
<img src="images/TelegramBotSocks5Docker2.png" title="Select Advanced Settings here" width="600" />


#### 3. Configure Network Port 
<img src="images/TelegramBotSocks5Docker3.png" title="Configure how the docker image should be reachable in your network" width="600" />
You can choose NAT or as shown in the screenshot bridge which means that the IP is the one from your NAS and the port is the default one 1080 or the one configured in PROXY_PORT.


#### 4. Configure username and password
<img src="images/TelegramBotSocks5Docker4.png" title="Username and password and port are optional." width="600" />
Remove PROXY_USER and PROXY_PASSWORD if you do not need any authentication in your local network.


#### 5. Click create to finish configuration
<img src="images/TelegramBotSocks5Docker5.png" title="Select Advanced Settings here" width="600" />


#### 6. The docker image should be up and running 
<img src="images/TelegramBotSocks5Docker6.png" title="Socks5 server is listening on port 1080" width="600" />


#### 7. Enter the IP of your Container Station and the port 1080 in your node-red telegram bot configuration and you are done.
Watch the output in the docker console. If user name and passord are wrong the output shows:
<img src="images/TelegramBotSocks5Docker7.png" title="Error: wrong user and/or password" width="600" />


#### 8. Enter user name and password in your node-red telegram bot configuration and you are done.
<img src="images/TelegramBotSocks5Docker8.png" title="Enter user name and password if required." width="600" />


#### 9. When the node shows status "Connected" then everything should work as expected..
<img src="images/TelegramBotSocks5Docker8.png" title="Node is connected." width="600" />


Network is now routed via the docker image in the container station in your local network.
This is only for testing and not to improve security. Remember that the socks5 proxy should be running somewhere else in the internet.