Portainer Templates logo

Portainer Templates

Go-Socks5-Proxy Go-Socks5-Proxy

Container

Proxy

Simple socks5 server using go-socks5 with authentication options

Image details

Pulls: 19.8M
Architecture: amd64, arm64, arm/v7, arm/v6
Image size: 2 MB
Latest: v0.0.4
User: serjs
Created: Oct 15, 2017
Updated: 10 months ago
Status: active

Configuration

Type
Container
Platform
linux
Image
serjs/go-socks5-proxy:latest
Ports
8080:8080/tcp
Restart
unless-stopped

Template by novaspirit

Notes

Standalone Install

Select an install method, to see config/commands for deploying Go-Socks5-Proxy

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Go-Socks5-Proxy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

go-socks5-proxy

Simple socks5 server using go-socks5 with authentication options

Start container with proxy

``docker run -d --name socks5 -p 1080:1080 -e PROXY_USER=<PROXY_USER> -e PROXY_PASSWORD=<PROXY_PASSWORD> serjs/go-socks5-proxy``
Leave PROXY_USER and PROXY_PASSWORD empty for skip authentication options while running socks5 server.

List of all supported config parameters

|ENV variable|Type|Default|Description| |------------|----|-------|-----------| |PROXYUSER|String|EMPTY|Set proxy user (also required existed PROXYPASS)| |PROXYPASSWORD|String|EMPTY|Set proxy password for auth, used with PROXYUSER| |PROXYPORT|String|1080|Set listen port for application inside docker container|

Test running service

Without authentication
``curl --socks5 <docker host ip>:1080 http://ifcfg.co`` - result must show docker host ip (for bridged network)
or
``docker run --rm curlimages/curl:7.65.3 -s --socks5 <docker host ip>:1080``
With authentication - result must show docker host ip (for bridged network)
``curl --socks5 --user <PROXY_USER>:<PROXY_PASSWORD> <docker host ip>:1080 http://ifcfg.co``
or
``docker run --rm curlimages/curl:7.65.3 -s --socks5 <PROXY_USER>:<PROXY_PASSWORD>@<docker host ip>:1080``

Authors

  • Sergey Bogayrets

See also the list of contributors
who participated in this project.

Serve Go-Socks5-Proxy on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying go-socks5-proxy.example.com to http://socks5-proxy:8080

Add this to your Caddyfile

go-socks5-proxy.example.com {
	reverse_proxy http://socks5-proxy:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs socks5-proxy
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8080 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8080
  • Stop the other service, or pick a different host port. In 8080:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, socks5-proxy can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8080

Image won't pull

Test the pull directly on the host: docker pull serjs/go-socks5-proxy:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm/v6
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect socks5-proxy --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Data disappears when the container is recreated

This template doesn't define any volumes, so everything socks5-proxy saves lives inside the container and is lost on update or recreate.

  • Add a volume mapping for socks5-proxy's data folder before storing anything you care about.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Go-Socks5-Proxy runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Go-Socks5-Proxy needs bundled into one download. This template pulls serjs/go-socks5-proxy:latest, which Docker fetches once (about 2 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Go-Socks5-Proxy's comes from Docker Hub, published by serjs.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is v0.0.4. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8080:8080 means it's reachable on port 8080 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8080 in a browser. It opens:

  • 8080:8080, likely the web interface

No stored data

This template doesn't mount any storage, so whatever Go-Socks5-Proxy writes stays inside the container and is wiped if it's recreated or updated. That's fine for something stateless, but add a volume before trusting it with anything you want to keep.

Restart policy

The restart policy here is unless-stopped, so Docker restarts Go-Socks5-Proxy after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Go-Socks5-Proxy sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container socks5-proxy. That's what you'll spot in the containers list and use in commands like docker logs socks5-proxy.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Go-Socks5-Proxy up. Add the template list to Portainer once, then deploying Go-Socks5-Proxy is a click rather than a wall of config.