Welcome to the Portus documentation!

On this page you can find information about:

Quick start

Are you new to Portus and you have no idea how to start with it? Please, follow this quick start guide.

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.

This guide will assume that you want to deploy Portus on production. In order to do this, you have to first install it on your system. You can do this in multiple ways, our favorite being installing Portus through the provided RPM. Note that there are other alternative ways to install Portus (see the Setups section in the sidebar on the left).

Now, before you jump into trying to use Portus in your browser, there are some configuration steps that you should follow. This is thoroughly explained in this document. After configuring Portus to your liking, restart your HTTP server and open Portus in your browser. You are required to tell Portus where your registry is located. In order to do so, please follow this page.

At this point, you should be able to enjoy Portus. Now you might want to read all the features that Portus provides. We hope that you like it!


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!