summerqlin / portus

Authorization service and frontend for Docker registry (v2)

Portus

Portus targets version 2 of the Docker registry API. It aims to act both as an authoritzation server and as a user interface for the next generation of the Docker registry.

Features

Fine-grained control of permissions

Portus supports the concept of users and teams. Each user has its personal Docker namespace where she has read (aka docker pull) and write (aka docker push) access.

A team is a group of users that have read and write access to a certain namespace.

Portus implements the token based authentication system described by the new version of the Docker registry. This can be used to have full control over the images served by an instance of the Docker registry.

Web interface for Docker registry

Portus provides quick access to all the images available on your private instance of Docker registry. User's privileges are taken into account to make sure private images (the ones requiring special rights also for docker pull) are not shown to unauthorized personnel.

Synchronization between the database and the registry

Portus' knowledge of the images available on the private instance of a Docker registry is built in two ways:

1. Using the notifications sent by the Docker registry itself.
2. Using the Catalog API endpoint.

The two methods complement each other. The first method is used to retrieve updates on the registry in real time, and the second one is used to double-check the consistency of the database with the registry. To read more on this topic, don't hesistate to check the wiki page about it.

Contributing

First of all, make sure that you have a working development environment. You can easily do this with either Docker or Vagrant, as it's explained on the wiki.

Also, make sure to understand our contribution guidelines, as explained in this document.

Happy hacking!

Licensing

Portus is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.