{"id":13597772,"url":"https://github.com/nskondratev/socks5-proxy-server","last_synced_at":"2025-04-05T23:07:28.476Z","repository":{"id":44378540,"uuid":"129718670","full_name":"nskondratev/socks5-proxy-server","owner":"nskondratev","description":"SOCKS5 proxy server","archived":false,"fork":false,"pushed_at":"2024-11-29T09:27:09.000Z","size":540,"stargazers_count":116,"open_issues_count":0,"forks_count":20,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-29T22:05:37.177Z","etag":null,"topics":["docker","docker-compose","self-hosted","socks5","socks5-proxy"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nskondratev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-16T09:29:49.000Z","updated_at":"2025-03-10T12:23:44.000Z","dependencies_parsed_at":"2024-01-02T19:42:13.490Z","dependency_job_id":"af87ec81-d8b8-4352-89c9-f839e0c64bf9","html_url":"https://github.com/nskondratev/socks5-proxy-server","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nskondratev%2Fsocks5-proxy-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nskondratev%2Fsocks5-proxy-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nskondratev%2Fsocks5-proxy-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nskondratev%2Fsocks5-proxy-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nskondratev","download_url":"https://codeload.github.com/nskondratev/socks5-proxy-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411231,"owners_count":20934653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","self-hosted","socks5","socks5-proxy"],"created_at":"2024-08-01T17:00:40.932Z","updated_at":"2025-04-05T23:07:28.443Z","avatar_url":"https://github.com/nskondratev.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Software","Proxy"],"sub_categories":["Proxy","Booking and Scheduling"],"readme":"# Socks5 proxy server\n## Prerequisites\n* Docker ([Install Docker](https://docs.docker.com/install/))\n\n## How to run\n- Copy *.env.example* file: `cp .env.example .env`\n- Fill in configuration: `nano .env`. Fields:\n  - **APP_PORT** - proxy server port (default: 54321),\n  - **LOG_LEVEL** - log level (default: INFO),\n  - **REQUIRE_AUTH** - if set to 1, anonymous users are not allowed.\n- Start application: `docker compose up -d`\n\n## CLI commands\nIn all commands you need to call js-script in app docker container.  \nSo you need to find out container name with proxy application by running the following command:\n```bash\ndocker compose ps\n```\n\nFor example, it will be `socks5-proxy-server-proxy-1`.\n\nIn all the following commands you need to replace `socks5-proxy-server-proxy-1` with the yours container name. \n\n### Create user\n```bash\ndocker exec -it socks5-proxy-server-proxy-1 sh -c 'exec node scripts/create-user.js'\n```\n\n### Delete user\n```bash\ndocker exec -it socks5-proxy-server-proxy-1 sh -c 'exec node scripts/delete-user.js'\n```\n\n### Show users statistics\n```bash\ndocker exec -it socks5-proxy-server-proxy-1 sh -c 'exec node scripts/users-stats.js'\n```\n\n## Telegram bot for administration\n### Configuration\n- Initialize bot at @botfather, get API token\n- Set params in .env:\n  - PUBLIC_URL - URL to server. E.g. http://proxy.domain.com:8443\n  - TELEGRAM_API_TOKEN - API token from BotFather\n  - TELEGRAM_WEBHOOK_URL - default: /webhook\n  - TELEGRAM_USE_WEBHOOKS - 1 - use webhooks, 0 - use polling. To use webhooks you need to generate ssl certificates\n- Create admin:\n```bash\ndocker exec -it socks5-proxy-server-telegram_bot-1 sh -c 'exec node scripts/create-admin.js' \n```\n\nYou also can delete admin via script, if you need:\n```bash\ndocker exec -it socks5-proxy-server-telegram_bot-1 sh -c 'exec node scripts/delete-admin.js' \n```\n\n### Available commands\n- `/users_stats` - show data usage statistics per user\n- `/create_user` - create new proxy user\n- `/delete_user` - delete proxy user\n- `/get_users` - get list of proxy users\n- `/generate_pass [length]` - generate random password with specified length (10 by default)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnskondratev%2Fsocks5-proxy-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnskondratev%2Fsocks5-proxy-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnskondratev%2Fsocks5-proxy-server/lists"}