Portus

• Website: http://port.us.org/
• Blog
• Mailing list: Google Groups
• Official Docker image

Portus is an authorization server and a user interface for the next generation of the Docker registry. 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.

master	v2.2	v2.3 (in development)	Code Climate

Features

Fine-grained control of permissions

Portus supports the concept of users and teams. Users have their own personal Docker namespace where they have both 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. You can read more about this in our documentation page about it.

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.

Self-hosted

Portus allows you to host everything on your servers, on your own infrastructure. You don't have to trust a third-party service, just own everything yourself. Take a look at our documentation to read the different setups in which you can deploy Portus.

And more!

Some highlights:

• Synchronization with your private registry in order to fetch which images and tags are available.
• LDAP user authentication.
• OAuth and OpenID-Connect authentication
• Monitoring of all the activities performed onto your private registry and Portus itself.
• Search for repositories and tags inside of your private registry.
• Star your favorite repositories.
• Disable users temporarily.
• Optionally use Application Tokens for better security.

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

Deploying

Containerized

In the examples directory you can find different containerized deployment examples. All these examples are using the opensuse/portus image, which can be found on Docker Hub, and they are defined in opensuse/docker-containers. We have the following tags:

• head: Portus' master branch packaged and curated as if it was production-ready. This is convenient for people that want to be on the bleeding edge and want to test the latest features.
• latest: the latest stable release.
• Version-specific tags (e.g. 2.3). We recommend using these tags for production clusters.

Moreover, there is also available a Helm Chart that you can use for Kubernetes' clusters.

Bare metal

Portus is a Ruby on Rails application and as such you can follow the usual steps to deploy such an application. If you need inspiration you may want to read an example with NGinx and Puma.

Development

If you simply want to explore Portus and play with it, using the development environment might be a good fit. A quick way to start a development version of Portus is to perform the following:

$ docker-compose up

For more information on development environments, check our wiki. Otherwise, feel free to explore the examples directory for a variety of ways in which you can deploy Portus.

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.1.x & 2.2.x	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 to 2.4
2.0.3+	1.6+	2.0 to 2.4

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. The wiki also has notable pages like How we test Portus.

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

Happy hacking!

Overview

In this video you can get an overview of some of the features and capabilities of Portus.

Licensing

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