diff --git a/README.md b/README.md index 842ea8a..4fde644 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,57 @@ -# docker-socks5 -Docker для поднятия socks5 proxy сервера +# Docker SOCKS5 Proxy + +Docker для запуска socks5 proxy-сервера + +## Quickstart + +Ниже приведена инструкция по подъему SOCKS5 прокси. Единственное требование - наличие [белого](https://help.keenetic.net/hc/ru/articles/213965789-В-чем-отличие-белого-и-серого-IP-адреса-) IP. + +1. Установите Docker engine. + + Выберите инструкцию для вашей системы. Тестирование всей системы проводилось только для Ubuntu, но для других систем все также должно работать с некоторыми модификациями приведенных ниже команд. + + 1. [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce) + 2. [Mac](https://docs.docker.com/docker-for-mac/install/) + 3. [Windows](https://docs.docker.com/docker-for-windows/install/) + +2. Склонируйте данный репозиторий + + ```bash + git clone https://github.com/elejke/docker-socks5.git + cd docker-socks5 + ``` + +3. Соберите Docker-образ + + ```bash + sudo docker build -t socks5 . + ``` + + Если вы хотите использовать логин и пароль для своего сервера, то исправьте соответствующую строчку в [Dockerfile](Dockerfile#L4) на желаемую пару логин/пароль. + +4. Запустите Docker-образ: + + ```bash + sudo docker run -d -p 80:1080 socks5 + ``` + + В данном случае прокси-сервер будет работать на порте 80. Вы можете изменить его на произвольный изменив соответствующее число при запуске Docker-контейнера. + + Если вы хотите использовать логин/пароль для своего прокси, то надо также добавить файл конфигурации в Docker-контейнер, что делается добавлением опции при запуске: + + ```bash + sudo docker run -d -p 80:1080 -v ${PWD}/sockd.conf:/etc/sockd.conf + ``` + + При этом будут использованы логин/пароль указанные на шаге 3. + +5. Ваш прокси-сервер готов! + + Используйте ваш IP-адрес, указанный на шаге 4 порт и логин/пароль (если заданы) в любом приложении! + + Для Telegram соответствующие настройки лежат в: + + 1. **iOS**: Settings - Data and Storage - Use Proxy + 2. **Desktop**: Settings - Privacy and Secutiry - Use Proxy + +