Skip to content

Socket Proxy: what it is, which apps need it and what to do when it stops

GuideDeployrr v6.0+CurrentDockerInstallApp networkingLogs

Socket Proxy is a small helper app that Deployrr installs from the Docker menu. Traefik, the Deployrr Dashboard and many other apps need it. This guide shows what it does, how to install it, which apps need it and what to do when it is not running.

Docker apps that watch or manage other containers need to talk to Docker. Many guides give each of those apps full access to Docker by mounting the Docker socket into it.

Deployrr does it another way for its core apps and most dashboard and monitoring apps. Socket Proxy is the container that touches the Docker socket. Those apps ask Socket Proxy for what they need. Socket Proxy only answers the requests it allows, so each app gets less power than direct access. A few apps still mount the Docker socket themselves.

To see what Socket Proxy does and how it is built by hand, watch Ultimate Docker Server: Docker Socket Proxy at 15:40 (manual setup, Deployrr does these steps for you). For background on how apps reach the Docker socket, read UDMS part 14: Socket Proxy and how apps reach the Docker socket (manual setup).

You install it once. After that, the apps that need it find it on their own. There is no web page for it and nothing to log in to.

  1. Start Deployrr.
  2. Choose Docker from the main menu.
  3. Look at the Socket Proxy line. It ends with one of these:
    • NOT INSTALLED: you have not installed it yet.
    • RUNNING: it is installed and running.
    • STOPPED: it is installed but not running. See When Socket Proxy is not running.
  4. Choose Socket Proxy. The line reads Setup Socket Proxy.
  5. In the Socket Proxy Installation box, read the text. Choose Yes to install.
  6. Wait while Deployrr works. You see these steps in the terminal:
    • Checking requirements..., then All requirements met
    • Copying configuration files...
    • Starting Socket Proxy container...
    • Waiting for Socket Proxy to initialize..., then Socket Proxy is running
  7. Look for Socket Proxy installed successfully!.

To see the older Deployrr 5 install, watch Deployrr 5 walkthrough: Socket Proxy setup at 26:13 (Deployrr v5, menus and steps differ in v6).

If Socket Proxy is already installed, Deployrr asks first. The box is titled Already Installed. It says socket-proxy is already running or socket-proxy is already installed. It tells you that reinstalling stops the existing container, recreates it with the latest image and keeps your data volumes. Choose Yes only if you want that.

  1. Go back to the Docker menu.
  2. The Socket Proxy line ends with RUNNING.

The main menu also shows a status next to Docker. It reads DONE when both Socket Proxy and the Deployrr Dashboard are running. It reads PARTIAL when only one is running. It reads INCOMPLETE when one is installed but neither is running. It shows nothing before you install either one.

Deployrr checks for Socket Proxy before it installs these. If it is missing, you see a box or a message instead of an install.

These show a Requirements Not Met box with this line:

Socket Proxy - Must be running (Docker menu)
  • Proxy > Traefik > Preparation, Staging and Production
  • Proxy > Traefik > Manage Exposure, Traefikify, Un-Traefikify, Domain Passthrough and Auth Bypass
  • Security > Authelia, Authentik, Google OAuth and TinyAuth (these also need a Pro license)

See Set up Traefik for the full Traefik order.

Deployrr Dashboard and apps from Browse Apps

Section titled “Deployrr Dashboard and apps from Browse Apps”

These show a message in the terminal:

Required app not running
[REQUIRED] socket-proxy must be installed and running first

Install Socket Proxy, then start the install again.

Uptime Kuma and What’s Up Docker (WUD) do not require Socket Proxy to install. They still join its network.

Signs that Socket Proxy is down:

  • The Docker menu shows STOPPED on the Socket Proxy line.
  • A box says Socket Proxy - Must be running (Docker menu).
  • The terminal says socket-proxy must be installed and running first.
  • Traefik, Portainer, Dozzle or another app can’t see your containers.

Stack Manager needs a Basic, Plus or Pro license.

  1. Choose Tools > Stack Manager > Start Container. See Stack Manager.
  2. At Select an app to start:, type the number of socket-proxy and press Enter. The list also offers all and exit. If it says No exited containers found., Socket Proxy is not stopped.
  3. Look for socket-proxy started.

If it does not stay up, use Recreate in the same menu. Pick socket-proxy from the list. Or run Docker > Socket Proxy again and choose Yes in the Already Installed box.

With the Deployrr bash aliases: dlogs socket-proxy. Press Ctrl+C to stop following.

Without the aliases:

Terminal window
sudo docker logs --tail 50 -f socket-proxy

With the Deployrr bash aliases: dpss. Without them:

Terminal window
sudo docker ps -a

Look for socket-proxy and its status.

After Socket Proxy is back, an app that lost contact may still show an error. Use Tools > Stack Manager > Recreate on that app. Pick it from the list.

If Traefik is the app, see Read the Traefik logs.

Deployrr keeps the Socket Proxy compose file in the compose/HOSTNAME folder inside your Docker folder. HOSTNAME is your server’s hostname. The file is named socket-proxy.yml.

You do not need to edit it. Stack Manager can start, stop and recreate it.