Skip to content

Glossary

View as Markdown

Terms as CloudRepo uses them, in the admin portal, in these docs and in error messages.

The web application at admin.cloudrepo.io, where you create repositories, users and repository tokens and manage your organization.

Your CloudRepo account. Its name is the first part of your repository host: for acme.mycloudrepo.io, the organization is acme.

A person’s account in your organization, created in the admin portal with an email address and a password. A user has either read and write access to every repository, or read only access to all of them, and can be granted administrator permissions one area at a time. See User Management.

Rights a user is granted one area at a time: billing, repositories, software distribution, users and webhooks. A user you create has none. See Administrator Permissions.

A dialog the admin portal shows before a sensitive action, such as creating a repository token, when you have not confirmed your identity in the last 15 minutes. You enter your password to continue.

The credential your build tools send to CloudRepo, also called an access token or API token. You create it under Repository Tokens in the admin portal. It reaches only the repositories you choose, is read only or read and write, and expires on the date you pick, or never. Clients that send a username use the email address of the account that created the token. See Repository Tokens.

The credential of a subscriber in Software Distribution. An access key reads from the repositories its subscriber group may use.

A named store for packages of one format: Maven, Python, npm or Docker. Its address is https://your-org.mycloudrepo.io/repositories/your-repo. See Repository Management.

The modes of a repository. A local repository stores what you publish. A proxy repository fetches from an upstream and keeps a copy. A group repository, offered for Maven and Docker only, is one address in front of several repositories. You choose the mode when you create the repository. See Creating a Repository.

A repository that retrieves what you ask for from an upstream, such as Maven Central, stores a copy in your organization and serves the copy. See Proxy Repositories.

The server a proxy repository fetches from. You choose it from a fixed list when you create the proxy. See Supported Remote Servers.

One address in front of several repositories, offered for Maven and Docker only. See Creating a Repository. A Docker group is read only and tries its members in priority order; see Docker Repositories.

A setting that lets anyone read a Maven, Python or npm repository without credentials, at the address https://your-org.mycloudrepo.io/public/repositories/your-repo. See Enabling Public Repository Access.

A repository setting, on by default in Maven, Python and npm repositories, that refuses to replace a file that is already stored. A publish that would replace one is refused with 409 Conflict. In Maven, -SNAPSHOT versions and maven-metadata.xml, with its checksum and signature files, are exempt. Docker repositories do not offer Overwrite Protection. See Maven Overwrite Protection, Python Overwrite Protection and Overwrite Protection.

Where a file you delete from a Maven or Python repository is listed, and where someone with the Manage Repositories permission can restore it. A restore applies only to a repository that holds your own files: a proxy repository refuses one. The Trash tab carries its own notice about how long deleted items stay. See Trash and Recovery.

A page on each repository that shows how to connect your clients to it, with the repository’s address filled in. See View Connection Settings.

In Maven, a version that ends in -SNAPSHOT is a snapshot: a development build that can be published again and again. Any other version is a release, which Overwrite Protection keeps fixed once published.

The group, artifact and version that identify a Maven artifact, such as com.example.docs, docs-maven and 1.0.0. They appear in a repository address as a path: com/example/docs/docs-maven/1.0.0/.

The address a Python client reads to find packages in a repository, https://your-org.mycloudrepo.io/repositories/your-repo/simple/. pip’s index URL names it, and twine uploads to the repository address without /simple/. See Repository Tokens.

What docker pushes to and pulls from: the host, then repositories/, then the repository, then the image and tag, as in your-org.mycloudrepo.io/repositories/your-repo/my-app:1.0.0. docker login takes the host alone. See Docker Repositories.

A way to give your customers (subscribers) read only access to chosen repositories, with an access key for each subscriber. See Software Distribution.

A customer you give read only access in Software Distribution. A subscriber belongs to one or more subscriber groups, and holds access keys.

A message CloudRepo sends to a server outside CloudRepo when a file is uploaded, downloaded or deleted in a Maven, Python or npm repository. See Webhooks.

The short name a CloudRepo response carries to say why it refused a request, such as scope_mismatch_repo. The codes documented so far each have a section, named for the code, on Error Codes.