/umschlag-api

Umschlag: API Server

Primary LanguageGoApache License 2.0Apache-2.0

Umschlag: API server

Build Status Coverage Status Go Doc Go Report Join the chat at https://gitter.im/umschlag/umschlag Stories in Ready

This project is under heavy development, it's not in a working state yet!

Where does this name come from or what does it mean? It's quite simple, it's one german word for transshipment, I thought it's a good match as it is related to containers and a harbor.

Umschlag will be a pretty simple web interface and authentication method for the new docker distribution, the new opensource private docker registry. I thought it's time to implement a shiny application with Go for the API and with React for the UI.

The structure of the code base is heavily inspired by Drone, so those credits are getting to bradrydzewski, thank you for this awesome project!

Install

You can download prebuilt binaries from the GitHub releases or from our download site. You are a Mac user? Just take a look at our homebrew formula. If you are missing an architecture just write us on our nice Gitter chat. Take a look at the help output, you can enable auto updates to the binary to avoid bugs related to old versions. If you find a security issue please contact thomas@webhippie.de first.

Development

Make sure you have a working Go environment, for further reference or a guide take a look at the install instructions. As this project relies on vendoring of the dependencies and we are not exporting GO15VENDOREXPERIMENT=1 within our makefile you have to use a Go version >= 1.6. It is also possible to just simply execute the go get github.com/umschlag/umschlag-api command, but we prefer to use our Makefile:

go get -d github.com/umschlag/umschlag-api
cd $GOPATH/src/github.com/umschlag/umschlag-api
make clean build

bin/umschlag-api -h

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

Apache-2.0

Copyright (c) 2016 Thomas Boerger <http://www.webhippie.de>