Readme: example config for docker-socket-proxy

Author: mohsenasm

README.md

@@ -101,7 +101,7 @@ List of environment variables for more customization:
 | CADVISOR_PORT                        | 8080                                                                                                              |                                                                                                                                                                                              |
 | ENABLE_DATA_API                      | true                                                                                                              | Use this env to export the `/data` API that returns the swarm status as a JSON object. Note that it requires basic-auth if `ENABLE_AUTHENTICATION` is activated.                             |
 | ENABLE_NETWORKS                      | false                                                                                                             | `true` by default, set to `false` to remove the network section from the dashboard.                                                                                                          |
-| DOCKER_SOCKET                        | tcp://localhost:2375                                                                                              | `/var/run/docker.sock` by default. You can use it with [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy).                                                              |
+| DOCKER_SOCKET                        | tcp://dockerproxy:2375                                                                                            | `/var/run/docker.sock` by default. You can use it with [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy).                                                              |
 
 ## Security
 
@@ -111,7 +111,7 @@ List of environment variables for more customization:
 
 + Using the `ENABLE_HTTPS` environment variable, there is an option to use `HTTPS` and `WSS`. We have Let’s Encrypt integration with the DNS challenge. See the example for more info.
 
-+ You can use [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) with the `DOCKER_SOCKET` environment variable to minimize permissions and enhance security.
++ You can use [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) with the `DOCKER_SOCKET` environment variable to minimize permissions and enhance security. Make sure that `swarm-dashboard` and `docker-socket-proxy` are in the same network. See the example configuration in [test-cluster/compose-dashboard.yml](./test-cluster/compose-dashboard.yml) for more detail.
 
 ## Rough roadmap
 

test-cluster/compose-dashboard.yml

@@ -13,6 +13,26 @@ services:
       ENABLE_HTTPS: "false"
       NODE_EXPORTER_SERVICE_NAME_REGEX: "node-exporter"
       CADVISOR_SERVICE_NAME_REGEX: "cadvisor"
+      # DOCKER_SOCKET: "/var/run/docker.sock"
+      DOCKER_SOCKET: "tcp://dockerproxy:2375"
+    networks:
+      - monitoring_net
+  
+  # using dockerproxy is optional
+  # see https://github.com/Tecnativa/docker-socket-proxy#usage
+  dockerproxy:
+    image: tecnativa/docker-socket-proxy
+    container_name: dockerproxy
+    privileged: true
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+    ports:
+      - "127.0.0.1:2375:2375"
+    environment:
+      NODES: 1
+      NETWORKS: 1
+      SERVICES: 1
+      TASKS: 1
     networks:
       - monitoring_net