5
5
[ ![ Docker Pulls] ( https://img.shields.io/docker/pulls/blamebutton/disrupt.svg?style=flat-square )] ( https://hub.docker.com/r/blamebutton/disrupt )
6
6
[ ![ Discord Widget] ( https://img.shields.io/discord/556492964050763817.svg?style=flat-square )] ( https://discord.gg/tDf2yBg )
7
7
8
+ ## Usage
9
+
10
+ ``` yaml
11
+ version : ' 3'
12
+
13
+ services :
14
+ whoami :
15
+ image : jwilder/whoami
16
+ ports :
17
+ - 8080:8000
18
+
19
+ disrupt :
20
+ image : blamebutton/disrupt
21
+ volumes :
22
+ - /var/run/docker.sock:/var/run/docker.sock
23
+ deploy :
24
+ placement :
25
+ constraints :
26
+ # Disrupt needs permission to update services, only managers are allowed to do that.
27
+ - node.role == manager
28
+ ` ` `
29
+
30
+ For more examples, check out the [examples folder](/.examples)
31
+
32
+ **Note**: Since Disrupt checks for updates by pulling the latest image, images built locally
33
+ won't trigger an update for now.
8
34
9
35
## Notifications
10
36
@@ -23,9 +49,25 @@ Here is a small list of notification providers that Apprise supports:
23
49
24
50
## Contributing
25
51
26
- Feel free to make a feature request or if you have Python experience; pull requests are welcome too!
52
+ Feel free to make a feature request or if you have Python experience; pull requests are welcome
53
+ too!
54
+
55
+ ## Troubleshooting
56
+
57
+ ### Could not connect to Docker Engine
58
+
59
+ Did you mount the Docker socket to the container? Check out the [example](#usage) if you want
60
+ to know how.
61
+
62
+ In the special case that you are accessing Docker over TCP, you should place Disrupt in the
63
+ same network as your TCP socket. Using a Docker socket proxy (like
64
+ [docker-socket-proxy](https://hub.docker.com/r/tecnativa/docker-socket-proxy/), or
65
+ [sockguard](https://github.com/buildkite/sockguard)) is recommended for enhanced security
66
+ in this case. You could then configure the proxy to only allow ` GET` requests for service info,
67
+ for example. That way, if the Disrupt container gets compromised it can't do any harm to the
68
+ cluster in the form of modifications/destructive instructions.
27
69
28
70
# # Support
29
71
30
- If you're having trouble getting Disrupt to work, we have a [ Discord server ] ( https://discord.gg/tDf2yBg )
31
- for support and questions.
72
+ If you're having trouble getting Disrupt to work, we have a
73
+ [Discord](https://discord.gg/tDf2yBg) for support and questions.
0 commit comments