Skip to content

Commit f17fdc9

Browse files
committed
2 parents 65f1395 + d3ac44e commit f17fdc9

2 files changed

Lines changed: 12 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,15 @@ These are the main tags for the image. There is also a tag for each commit and i
1313
* [latest](https://hub.docker.com/r/11notes/socket-proxy/tags?name=latest)
1414

1515
# SYNOPSIS 📖
16-
**What can I do with this?** This image will run a proxy to access your docker socket as read-only. The exposed proxy socket is run as 1000:1000, not as root, although the image starts the proxy process as root to interact with the actual docker socket. There is also a TCP endpoint started at 2375 that will also proxy to the actual docker socket if needed. It is not exposed by default and must be exposed via using ```- "2375:2375/tcp"``` in your compose.
16+
**What can I do with this?** This image will run a proxy to access your docker socket as read-only. The exposed proxy socket is run as 1000:1000, not as root, although the image starts the proxy process as root to interact with the actual docker socket. There is also a TCP endpoint started at 2375 that will also proxy to the actual docker socket if needed. It is not exposed by default and must be exposed via using ```- "2375:2375/tcp"``` in your compose. Make sure that the docker socket is accessible by the ```user:``` specification in your compose, if the UID/GID are not correct, the image will print out the correct UID/GID for you to set:
17+
18+
```shell
19+
socket-proxy-1 | 2025/03/26 10:16:33 can’t access docker socket as GID 0 owned by GID 991
20+
socket-proxy-1 | please change the user setting in your compose to the correct UID/GID pair like this:
21+
socket-proxy-1 | services:
22+
socket-proxy-1 | socket-proxy:
23+
socket-proxy-1 | user: "0:991"
24+
```
1725

1826
# UNIQUE VALUE PROPOSITION 💶
1927
**Why should I run this image and not the other image(s) that already exist?** Good question! All the other images on the market that do exactly the same don’t do or offer these options:
@@ -34,6 +42,7 @@ name: "traefik" # this is a compose example for Traefik
3442
services:
3543
socket-proxy:
3644
image: "11notes/socket-proxy:2.0.0"
45+
user: "0:0" # make sure to use the same UID/GID as the owner of your docker socket!
3746
volumes:
3847
- "/run/docker.sock:/run/docker.sock:ro" # mount host docker socket, the :ro does not mean read-only for the socket, just for the actual file
3948
- "socket-proxy:/run/proxy" # this socket is run as 1000:1000, not as root!
@@ -119,4 +128,4 @@ This image is not based on another image but uses [scratch](https://hub.docker.c
119128
# ElevenNotes™️
120129
This image is provided to you at your own risk. Always make backups before updating an image to a different version. Check the [releases](https://github.com/11notes/docker-socket-proxy/releases) for breaking changes. If you have any problems with using this image simply raise an [issue](https://github.com/11notes/docker-socket-proxy/issues), thanks. If you have a question or inputs please create a new [discussion](https://github.com/11notes/docker-socket-proxy/discussions) instead of an issue. You can find all my other repositories on [github](https://github.com/11notes?tab=repositories).
121130

122-
*created 24.03.2025, 13:29:58 (CET)*
131+
*created 26.03.2025, 11:26:47 (CET)*

compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: "traefik" # this is a compose example for Traefik
22
services:
33
socket-proxy:
4-
image: "11notes/socket-proxy:2.1.0"
4+
image: "11notes/socket-proxy:2.0.0"
55
user: "0:0" # make sure to use the same UID/GID as the owner of your docker socket!
66
volumes:
77
- "/run/docker.sock:/run/docker.sock:ro" # mount host docker socket, the :ro does not mean read-only for the socket, just for the actual file

0 commit comments

Comments
 (0)