Skip to content
jacob-carlborg edited this page Jul 16, 2011 · 1 revision

The repository is just a simple HTTP web server or a local directory. The web server stores all the packages and metadata. When the user installs a package it requires just one request to the server to get the metadata, the tool then figures out what other packages the package to be installed depends on and downloads them if necessary.

Specification

The following is a specification of how a repository behaves and must provide to be able to be used as an orbit repository. Assuming "dorbit.org" is the root of the repository, the following is a list of resources and HTTP methods the repository must provide:

/metadata.<format> - GET - The complete list of metadata for all orb packages in the repository, where <format> is either "xml", "json" or "yml".

/orbs/<package>-<version> - GET - Returns the specified orb package, where <package> is the name of the package and <version> is the version of the package. It's recommended that this will give direct access to the package instead of assembling and streaming the package.

/orbs - POST - Uploads an orb package

Clone this wiki locally