imageup

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 29, 2017 License: MIT Imports: 4 Imported by: 0

README

ImageUp

Build Status Docker Repository on Quay

Pull Docker images via HTTP webhook

Currently supported:

Requirements

  • Docker

Installation

Run in a Docker container

Docker image is available at quay.io/dtan4/imageup.

docker run \
  --rm \
  --name imageup \
  -p 8000:8000 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  quay.io/dtan4/imageup:latest
From source
go get -d github.com/dtan4/imageup
cd $GOPATH/src/github.com/dtan4/imageup
make deps
make install

Usage

1. Launch ImageUp server

Enabling HTTP basic auth (IMAGEUP_BASIC_AUTH_USERNAME, IMAGEUP_BASIC_AUTH_PASSWORD) and pullable image whitelise (IMAGEUP_BASIC_AUTH_WHITELIST) is strongly recommended for security reason.

ImageUp server launches at 8000/tcp by default. If you'd like to change th port, please specify IMAGEUP_PORT.

# binary on local machine
export IMAGEUP_BASIC_AUTH_USERNAME=username
export IMAGEUP_BASIC_AUTH_PASSWORD=password
export IMAGEUP_IMAGE_WHITELIST=quay.io/dtan4/imageup,nginx
imageup

# Docker container
docker run \
  --rm \
  --name imageup \
  -p 8000:8000 \
  -e IMAGEUP_BASIC_AUTH_USERNAME=username \
  -e IMAGEUP_BASIC_AUTH_PASSWORD=password \
  -e IMAGEUP_IMAGE_WHITELIST=quay.io/dtan4/imageup,nginx \
  -v /var/run/docker.sock:/var/run/docker.sock \
  quay.io/dtan4/imageup:latest
2. Configure webhook from Quay

Go to https://quay.io/repository/<username>/<image>?tab=settings, then click "+ Create Notification".

notification settings:

  • When this event occurs: "Dockerfile Build Successfully Completed"
  • Then issue a notification: "Webhook POST"
  • Webhook URL: http(s)://<username>:<password>@<yourdomain>/webhooks/quay

3. Build image

After image build completed, the image will be pulled automatically 🎉

Environment variables
Key Required Description Default Example
IMAGEUP_BASIC_AUTH_USERNAME Basic auth username username
IMAGEUP_BASIC_AUTH_PASSWORD Basic auth password password
IMAGEUP_IMAGE_WHITELIST Pullable image whitelist (comma-separated) quay.io/dtan4/imageup,nginx
IMAGEUP_PORT HTTP server port 8000 8123

Author

Daisuke Fujita (@dtan4)

License

MIT License

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL