@@ -15,7 +15,7 @@ services:
15
15
image : jwilder/whoami
16
16
ports :
17
17
- 8080:8000
18
-
18
+
19
19
disrupt :
20
20
image : blamebutton/disrupt
21
21
volumes :
@@ -32,9 +32,21 @@ For more examples, check out the [examples folder](/.examples)
32
32
33
33
**Note**: Docker Swarm does not support running locally built images, so neither does Disrupt.
34
34
35
+ ## Configuration
36
+
37
+ Configuration of Disrupt is done through environment variables. This is done to make the deployment of Disrupt
38
+ environment-agnostic.
39
+
40
+ Below is a list of environment variables available to be configured.
41
+
42
+ | Name | Type | Options |
43
+ | - | - | - |
44
+ | UPDATE_DELAY | Integer | default = 300 |
45
+ | NOTIFICATION_URL | String | Any [Apprise](https://github.com/caronc/apprise#popular-notification-services) compatible URL |
46
+
35
47
## Notifications
36
48
37
- Disrupt uses the [Apprise](https://github.com/caronc/apprise) notification library for Python.
49
+ Disrupt uses the [Apprise](https://github.com/caronc/apprise) notification library for Python.
38
50
Check out their documentation for more advanced usages.
39
51
40
52
Here is a small list of notification providers that Apprise supports:
@@ -49,25 +61,25 @@ Here is a small list of notification providers that Apprise supports:
49
61
50
62
## Contributing
51
63
52
- Feel free to make a feature request or if you have Python experience; pull requests are welcome
64
+ Feel free to make a feature request or if you have Python experience; pull requests are welcome
53
65
too!
54
66
55
67
## Troubleshooting
56
68
57
69
### Could not connect to Docker Engine
58
70
59
- Did you mount the Docker socket to the container? Check out the [example](#usage) if you want
71
+ Did you mount the Docker socket to the container? Check out the [example](#usage) if you want
60
72
to know how.
61
73
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.
74
+ In the special case that you are accessing Docker over TCP, you should place Disrupt in the
75
+ same network as your TCP socket. Using a Docker socket proxy (like
76
+ [docker-socket-proxy](https://hub.docker.com/r/tecnativa/docker-socket-proxy/), or
77
+ [sockguard](https://github.com/buildkite/sockguard)) is recommended for enhanced security
78
+ in this case. You could then configure the proxy to only allow ` GET` requests for service info,
79
+ for example. That way, if the Disrupt container gets compromised it can't do any harm to the
80
+ cluster in the form of modifications/destructive instructions.
69
81
70
- # # Support
82
+ # # Support
71
83
72
- If you're having trouble getting Disrupt to work, we have a
84
+ If you're having trouble getting Disrupt to work, we have a
73
85
[Discord](https://discord.gg/tDf2yBg) for support and questions.
0 commit comments