- 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 |
---|---|---|---|
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.
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.
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.
Some highlights:
- Synchronization with your private registry in order to fetch which images and tags are available.
- LDAP user 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.
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 themaster
branch and in2.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 Portus2.0.0
nor2.0.1
.
You can deploy Portus in a wide variety of ways. Most commonly:
- Using containers: in the
examples
directory you can find different containerized deployment examples (e.g. with Kubernetes). - A bare metal setup: you can either do it by installing the RPM or installing everything yourself with NGinx and Puma.
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!
In this video you can get an overview of some of the features and capabilities of Portus.
Portus is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.