Harbor

README

Harbor

Harbor is a lightweight Web UI designed in Golang for your private Docker Registry.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Harbor is designed in Golang, if you want to build it on your computer you need Golang. You can also run in in Docker container.

Installing

With Docker :

$ git clone https://github.com/wallforfry/harbor
$ cd harbor
$ docker built -t golang/harbor .
$ docker run -it --name harbor -p 3008:3008 golang/harbor

Your project is now running in a container named harbor and expose port 3008 to your host. Access to http://localhost:3008/ to see the Web UI

On your computer :

$ go get wallforfry.fr/harbor
$ cd $GOPATH/src/wallforfry.fr/harbor
$ go get -d -v ./...
$ go install -v ./...
$ $GOPATH/bin/harbor

Your project is now running and expose port 3008 to your host. Access to http://localhost:3008/ to see the Web UI

Configuration

You can change some values in the config file config.json like :

• Port : The port of the webserver | default 3008
• RegistryUrl : Your private registry URL | default ""
• AppTitle : The name of your organisation | default "WebUI"
• Language : The language of the UI | default "en"

Language

You can choose language value between fr and en but you can also create your own language file in the locales directory.

Deployment

You can deploy Harbor inside Docker or has a service.

Built With

• Mux - A powerful URL router and dispatcher for Golang
• Gonfig - Manage Configuration file and environment in GO
• Materialize - A modern responsive front-end framework based on Material Design
• GoRequest - Simplified HTTP client
• GJSON - Get JSON values quickly - JSON Parser for Go

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Wallerand Delevacq - Initial work - wallforfry

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.