Skip to content

Commit

Permalink
README.md update (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bram Ceulemans authored and raqbit committed Mar 17, 2019
1 parent 096ed13 commit 953d469
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .examples/notifications/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ services:
- "/var/run/docker.sock:/var/run/docker.sock"
environment:
UPDATE_DELAY: 300
NOTIFICATION_URL: discord://webhook_id/webhook_token
# format=markdown is required for cards in Discord
NOTIFICATION_URL: discord://webhook_id/webhook_token?format=markdown
deploy:
placement:
constraints:
Expand Down
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,32 @@
[![Docker Pulls](https://img.shields.io/docker/pulls/blamebutton/disrupt.svg?style=flat-square)](https://hub.docker.com/r/blamebutton/disrupt)
[![Discord Widget](https://img.shields.io/discord/556492964050763817.svg?style=flat-square)](https://discord.gg/tDf2yBg)

## Usage

```yaml
version: '3'

services:
whoami:
image: jwilder/whoami
ports:
- 8080:8000

disrupt:
image: blamebutton/disrupt
volumes:
- /var/run/docker.sock:/var/run/docker.sock
deploy:
placement:
constraints:
# Disrupt needs permission to update services, only managers are allowed to do that.
- node.role == manager
```
For more examples, check out the [examples folder](/.examples)
**Note**: Since Disrupt checks for updates by pulling the latest image, images built locally
won't trigger an update for now.
## Notifications
Expand All @@ -23,9 +49,25 @@ Here is a small list of notification providers that Apprise supports:
## Contributing
Feel free to make a feature request or if you have Python experience; pull requests are welcome too!
Feel free to make a feature request or if you have Python experience; pull requests are welcome
too!
## Troubleshooting
### Could not connect to Docker Engine
Did you mount the Docker socket to the container? Check out the [example](#usage) if you want
to know how.
In the special case that you are accessing Docker over TCP, you should place Disrupt in the
same network as your TCP socket. Using a Docker socket proxy (like
[docker-socket-proxy](https://hub.docker.com/r/tecnativa/docker-socket-proxy/), or
[sockguard](https://github.com/buildkite/sockguard)) is recommended for enhanced security
in this case. You could then configure the proxy to only allow `GET` requests for service info,
for example. That way, if the Disrupt container gets compromised it can't do any harm to the
cluster in the form of modifications/destructive instructions.

## Support

If you're having trouble getting Disrupt to work, we have a [Discord server](https://discord.gg/tDf2yBg)
for support and questions.
If you're having trouble getting Disrupt to work, we have a
[Discord](https://discord.gg/tDf2yBg) for support and questions.

0 comments on commit 953d469

Please sign in to comment.