Authorization service and frontend for Docker registry (v2)
Ruby HTML CSS Other Shell CoffeeScript
Latest commit b450ea1 Jan 23, 2017 @mssola mssola committed on GitHub Merge pull request #1152 from SUSE/fix_release_to_use_no_dash
fix release script so that we can use 2.2.0rc1
Permalink
Failed to load latest commit information.
app Fixed some bugs related to activities Jan 20, 2017
bin bin: fixed test data generator Aug 10, 2016
compose Add registry port cmd Oct 19, 2016
config spec enhancements Nov 2, 2016
db Support Docker Distribution 2.5 Sep 28, 2016
deploy naming variable properly Aug 1, 2015
doc Provide webhooks base Jun 2, 2016
lib lib/tasks: only allow the man.rake file in development and testing Oct 21, 2016
packaging/suse fix release script so that we can use 2.2.0rc1 Jan 23, 2017
public Replaced any references to old wiki pages to the proper documentation… Nov 12, 2015
spec Fixed some bugs related to activities Jan 20, 2017
vagrant Removed all the observers Sep 23, 2015
vendor/assets Updated float alerts and added float-alert class to errors Jun 1, 2016
.dockerignore ISSUE-202: Updated gitignore to include osx DS_Store files Jul 22, 2015
.erdconfig Integrated rails-erd into development Apr 11, 2016
.gitignore spec/integration: added integration testing Apr 29, 2016
.rspec Added the .rspec file Jun 15, 2015
.rubocop.yml Added the registry.catalog_page option Jul 21, 2016
.ruby-version Added the Ruby version from SLE12 Jun 15, 2015
.travis.yml Fix builds for ruby 2.3.x Sep 30, 2016
.travis_mariadb.sh spec/integration: added integration testing Apr 29, 2016
CHANGELOG.md Updated changelog Oct 13, 2016
CONTRIBUTING.md Added a rake task showing general info Mar 30, 2016
Dockerfile provide phantomjs via rubygem Oct 28, 2016
Gemfile spec enhancements Nov 2, 2016
Gemfile.lock Merge pull request #1133 from mssola/puma-update Dec 13, 2016
Guardfile Integrated guard into development environment Apr 12, 2016
LICENSE Add licensing details Apr 22, 2015
README.md Updated the VERSION and the README files Sep 30, 2016
Rakefile Abide to SUSE's style guide Aug 3, 2015
VERSION Updated the VERSION and the README files Sep 30, 2016
Vagrantfile Use rake db:seed instead of portus:create when provisioning Vagrant a… Aug 11, 2015
compose-setup.sh Add registry port cmd Oct 19, 2016
config.ru Better Sub-URI handling & configurable config-local.yml path May 2, 2016

README.md

Portus

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.1 Code Climate
Build Status Build Status Code Climate Test Coverage

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:

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.1 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.

Overview

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

preview

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!

Licensing

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