Public | Automated Build

Last pushed: a year ago
Short Description
Portus
Full Description

Portus

Portus targets version 2
of the Docker registry API. The minimum required version of Registry is 2.1,
which is the first version supporting soft deletes of blobs. 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.

Take a tour by our documentation site to
read more about this.

Supported versions

Docker technologies have a fast iteration pace. This is a good thing, but it
comes with some challenges. As requested by some of our users, the following
table shows which versions of Docker and Docker Distribution are supported by
each Portus version:

Portus Docker Engine Docker Distribution
master 1.6+ 2.0+
2.0.0 & 2.0.1 1.6 to 1.9 2.0 to 2.2
2.0.2 1.6 to 1.9 2.0+
2.0.3 (soon to be released) 1.6+ 2.0+

Let's detail some of the version being specified:

  • Docker Engine 1.6 is the first version supported by Docker Distribution 2.
    Therefore, this requirement is also the same for Portus.
  • As of Docker 1.10, the Manifest Version 2, Schema 2 is the one being used.
    This is only supported by Portus in the master branch and in 2.0.3.
  • Docker Distribution 2.3 supports both Manifest versions, but some changes
    had to be made in order to offer backwards compatibility. This is not
    supported neither for Portus 2.0.0 nor 2.0.1.

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.

Docker Pull Command
Owner
senk
Source Repository

Comments (0)