https://github.com/schickling/docker-hook
Automatic Docker Deployment via Webhooks
https://github.com/schickling/docker-hook
Last synced: over 1 year ago
JSON representation
Automatic Docker Deployment via Webhooks
- Host: GitHub
- URL: https://github.com/schickling/docker-hook
- Owner: schickling
- License: mit
- Created: 2015-02-20T17:43:01.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-08-16T05:28:45.000Z (almost 6 years ago)
- Last Synced: 2025-04-09T23:17:17.853Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 13.7 KB
- Stars: 257
- Watchers: 7
- Forks: 50
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-hook
> Automatic Docker Deployment via [Webhooks](https://docs.docker.com/docker-hub/repos/#webhooks)
`docker-hook` listens to incoming HTTP requests and triggers your specified command.
## Features
* No dependencies
* Super lightweight
* Dead **simple setup process**
* Authentification support
## Setup
### 1. Prepare Your Server
#### Download `docker-hook`
No worries - it just downloads a Python script. There won't be anything installed or written elsewhere.
```sh
$ curl https://raw.githubusercontent.com/schickling/docker-hook/master/docker-hook > /usr/local/bin/docker-hook; chmod +x /usr/local/bin/docker-hook
```
#### Start `docker-hook`
```sh
$ docker-hook -t -c
```
##### Auth-Token
Please choose a secure `auth-token` string or generate one with `$ uuidgen`. Keep it safe or otherwise other people might be able to trigger the specified command. You can pass the `auth-token` as a command line argument, or set it as an environment variable.
##### Command
The `command` can be any bash command of your choice. See the following [example](#example). This command will be triggered each time someone makes a HTTP request.
### 2. Configuration On Docker Hub
Add a webhook like on the following image. `example.com` can be the domain of your server or its ip address. `docker-hook` listens to port `8555`. Please replace `my-super-safe-token` with your `auth-token`.
## Example
This example will stop the current running `yourname/app` container, pull the newest version and start a new container.
```sh
$ docker-hook -t my-super-safe-token -c sh ./deploy.sh
```
If you want to store the authentication token as an environment variable, then run
```sh
# Make sure there is no space before or after the `=` sign
$ export DOCKER_AUTH_TOKEN=
$ docker-hook -c sh ./deploy.sh
```
#### `deploy.sh`
```sh
#! /bin/bash
IMAGE="yourname/app"
docker ps | grep $IMAGE | awk '{print $1}' | xargs docker stop
docker pull $IMAGE
docker run -d $IMAGE
```
You can now test it by pushing something to `yourname/app` or by running the following command where `yourdomain.com` is either a domain pointing to your server or just its ip address.
```sh
$ curl -X POST yourdomain.com:8555/my-super-safe-token
```
## How it works
`docker-hook` is written in plain Python and does have **no further dependencies**. It uses `BaseHTTPRequestHandler` to listen for incoming HTTP requests from Docker Hub and then executes the provided [command](#command) if the [authentification](#auth-token) was successful.
## Caveat
This tool was built as a proof-of-concept and might not be completly secure. If you have any improvement suggestions please open up an issue.
## License
[MIT License](http://opensource.org/licenses/MIT)