pirate

Pirate

Introduction

Pirate which sounds like "private" is the website of private docker-registry.

Key Features:

• Lightweight UI for private registry's information like images/configuration
• Readonly mode to be used anonymous
• (TODO) link to internal/external web sites for more detail information for each image

For quick start, checkout the demo website.

Usage

Please run like below

docker run -d -p 5000:5000 --name registry registry
docker run -d -p 9527:9527 --link registry:registry tobegit3hub/pirate

• Then monitor your docker daemon in http://127.0.0.1:9527.
• For boot2docker users, please run boot2docker ip to find out the real IP.

Configuration

So far follow configurations are supported, you can pass via like -e PIRATE_MODE=readonly for docker run command.

• PIRATE_MODE=readonly|DELETE : default is DELETE, disable DELETE operation for each image, good for anonymous access
• REGISTRY_URL=<registry url> : default is registry:5000, don't put http in front.

Feature: More docker image information

see detail in issue #18

In order to get more information for docker image, it is planned to store image information inside docker image, Since current registry API just provide simple info.

In Dockerfile, this could be good practice for your Dockerfile. It can be used for other purpose as well

ADD . /app

Then in this app, it will scan the /registry raw data to retrieve this information

root@boot2docker:/mnt/sda1/var/lib/docker/aufs/diff/b3f7db6bab993bf243713b94d657aff4982be95b344c7abfd5941b339de073ec# ls -1 app
Dockerfile
LICENSE
README.md
DOCKER.pkg
data
...

Share data between registry

In order to let pirate get registry data, it needs to be shared (you can use data container as well)

For example you have /mnt/sda1/registry for sharing data (boot2docker env)

# mkdir /mnt/sda1/registry
docker run -d -p 5000:5000 -v /mnt/sda1/registry:/tmp/registry --name registry registry
docker run -d -p 9527:9527 -v /mnt/sda1/registry:/registry --link registry:registry tobegit3hub/pirate

Testing

Tag local testing images

docker tag hello-world localhost:5000/hello-world
docker tag hello-world localhost:5000/hello-world:1.0
docker tag hello-world localhost:5000/larrycai/hello-world

Push images into registry

docker push localhost:5000/hello-world
docker push localhost:5000/hello-world:1.0
docker push localhost:5000/larrycai/hello-world	

Get Involved

Pirate is implemented in Go and JavaScript with tools like Beego, AngularJS, Bootstrap, Bower, JQuery and Docker. You can fork the repository and send pull-request as you want.

• Setup go path and try echo $GOPATH
• go get github.com/astaxie/beego
• go get github.com/tobegit3hub/pirate
• ./pirate

Debug locally inside docker

git clone the code to the local directly, it is ok for Windows & MacOS as well, for example ~/git/docker/pirate

Then simple use shared folder to debug it

docker run -it -p 9527:9527 --link registry:registry -v $PWD:/go/src/github.com/tobegit3hub/pirate tobegit3hub/pirate bash
root@55640c0fb4f3:/go/src/github.com/tobegit3hub/pirate# go run pirate.go

If you want to have docker image feature

docker run -it -p 9527:9527 --link registry:registry -v /mnt/sda1/registry:/registry -v $PWD:/go/src/github.com/tobegit3hub/pirate tobegit3hub/pirate bash
root@55640c0fb4f3:/go/src/github.com/tobegit3hub/pirate# go run pirate.go

More detail in seagull-design-and-implement and we have excellent documents in docs.