Welcome to the Portus documentation!

On this page you can find information about:

• The first steps into using Docker and your registry.

• How to configure Portus.

• How Portus connects to the database and configuration options.

• How to setup a secure private registry.

• How Portus can be deployed.

• Letting Portus know about your private registry.

• How assets are managed in production.

• How to use secrets in containerized deployments.

• Specification of the Portus REST API.

• The background process needed to keep Portus in sync with other components.

• Configure and manage a Portus instance installed with the RPM.

• How to upgrade Portus across different versions.

• Which Docker versions are supported by Portus.

• How to debug problems that may occur.

• How we release Portus.

• How to migrate from the RPM to a containerized deployment.

• What to expect in future releases of Portus.

• Frequently asked questions.

Quick start

First of all, if you are only interested in knowing how you can login and push images to a registry which has Portus as an authorization service, you might be interested in reading this page for newcomers. Otherwise, if you need to install or deploy Portus, you can do it in two ways:

• Set it up for development purposes. This is the best way to mess with Portus and getting to know it. Read more about this here.
• Deploy Portus in production.

Contributing

Please feel free to create issues here if you would like to request more material to be created for the Portus documentation. If you want to contribute directly to this documentation page, you might want to open up a new pull request against the gh-pages branch.

For any other doubt that you may have regarding our documentation or anything about Portus in general, feel free to say something in our mailing list.

Thanks for your support!