Skip to content

Commit e1f279f

Browse files
author
Bram Ceulemans
committed
docs: added configuration section which lists all environment variables that are available
1 parent aaccf8d commit e1f279f

File tree

2 files changed

+38
-14
lines changed

2 files changed

+38
-14
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ services:
1515
image: jwilder/whoami
1616
ports:
1717
- 8080:8000
18-
18+
1919
disrupt:
2020
image: blamebutton/disrupt
2121
volumes:
@@ -32,9 +32,21 @@ For more examples, check out the [examples folder](/.examples)
3232
3333
**Note**: Docker Swarm does not support running locally built images, so neither does Disrupt.
3434
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+
3547
## Notifications
3648
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.
3850
Check out their documentation for more advanced usages.
3951
4052
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:
4961
5062
## Contributing
5163
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
5365
too!
5466
5567
## Troubleshooting
5668
5769
### Could not connect to Docker Engine
5870
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
6072
to know how.
6173
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.
6981

70-
## Support
82+
## Support
7183

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
7385
[Discord](https://discord.gg/tDf2yBg) for support and questions.

docker/DESCRIPTION.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,17 @@
1818

1919
# What is Disrupt?
2020

21-
Disrupt is a Python script that will check for updates for the images of your Docker Swarm services.
21+
Disrupt is a Python script that will check for updates for the images of your Docker Swarm services.
2222
Disrupt can either run in a container or on the host itself.
23+
24+
## Configuration
25+
26+
Configuration of Disrupt is done through environment variables. This is done to make the deployment of Disrupt
27+
environment-agnostic.
28+
29+
Below is a list of environment variables available to be configured.
30+
31+
| Name | Type | Options |
32+
| - | - | - |
33+
| UPDATE_DELAY | Integer | default = 300 |
34+
| NOTIFICATION_URL | String | Any [Apprise](https://github.com/caronc/apprise#popular-notification-services) compatible URL |

0 commit comments

Comments
 (0)