Distribute locally developed Puppet modules and proxy to the official Puppet Forge server.

Container for running the puppet_forge_server project from Github. This project allows one to serve locally developed Puppet forge modules and proxy requests to an upstream Puppet forge server (typically the official server run by Puppetlabs).

Puppet Forge Server provides an approximated implementation of both v1 and v3 APIs, but behavioral deviations from the official implementation might occur.

Puppet 2, 3 and 4, as well as librarian-puppet, are supported.

Server Architecture

The code is structured with MVC in mind to allow easier maintenance and readability

API (view)

API classes (actually modules only) are used to extend Sinatra application classes. Every module corresponds to official API endpoint and used to present received model data in fashion required by the given API version.


App (controller)

Every App class is a Sinatra application class and is responsible for mapping API endpoints, querying backends for requested data and providing the results using API (view) modules.



Puppet module metadata json representation is used as a main business model



Backend classes are providing the means of fetching required data and creating model instances.


How to use this container

The container, when invoked with no arguments, will start the Puppet forge server at port 8080 with local Puppet forge modules locate in /puppet/modules. If a volume mount is not specified to /puppet/modules, then all modules are kept within the container and the modules will be purged upon restarting the container. In addition, the log files for the service are kept in /puppet/logs.

If any arguments are provided after the container name and begin with a dash, then the arguments are provided as arguments to the Puppet forge server. Otherwise, the arguments are executed as a command within the context of the container.

In addition, there are a couple of meta-commands that the container will respond to. If readme, info, or help (all case-insensitive) are specified as the first argument, then this README file will be displayed. Also if the argument is the version, then the current Puppet forge server version is printed.

Tell us about a new Kubernetes application


Never miss a thing! Sign up for our newsletter to stay updated.


Discover and learn about everything Kubernetes