Cloudsmith Documentation Hub

Welcome to the Cloudsmith Documentation Hub. You'll find comprehensive guides and documentation to help you start working with Cloudsmith as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Organizations

Creating an Organization (Org) in Cloudsmith gives you the ability to configure access for teams, individuals and machines that map to your companies organizational structure. Building security and resilience into the management of teams and workflows is essential in today's ecosystem. This is a quick start guide to the powerful permission system within Cloudsmith and how you can get started.

Create an Organization

To create a new Organization, click the "ORGS" dropdown at the top of the page, then select "Manage Orgs" and once redirected to the Organization page, create a new Organization using the green "+ New Organization" button:

Create a New Organization

You are now ready to create your Organization using the reate Organization form. You are required to enter a name for your Organization and a primary email address before creating your Organization (don't worry, we will check your organization name is unique for you before creating it).

Create Organization Form

Once you have created the Organization, you will be presented with the Organization page that shows you all the Organizations you are currently a member of. To configure the settings for the Organization, click on the name of the Organization then click on the Settings tab:

Organizations Page

Organization Settings Tab.


Organization Settings

The menu on the left is where you can modify/configure Organization settings, and has the following sections:

  • Profile
  • Account
  • Billing
  • Global Privileges
  • Object Privileges
  • Security
  • Team Settings

Profile

The Organization profile settings are where you configure the Organization name, contact email addresses (including billing email address if different from the primary email address) and other optional information such as Location, URL, and Tagline:

Organization Profile Settings


Account

From within the Organization account settings page, you have the ability to rename your organization's slug/identifier, and if you really need too, you can delete an organization (caution: this is a permanent action and cannot be undone).

Organization Account Settings

🚧

If you rename the Organization, then the URI that is used to connect to any repositories will change. This change will affect any users that currently use the repositories as the URI would no longer be valid.


Billing

The Organization billing settings are where you add or change your payment source, view your invoices and select / modify your current plan:

Organization Billing Settings


Global Privileges

Organization Global Privileges are where you configure the permissions for current Organization members to invite collaborators, new Organization members, create new teams and create new repositories:

Organization Global Privileges


Object Privileges

Organization Object Privileges are where you configure the default privileges for objects within a package repository:

Organization Object Privileges

  • Admin - Members have full control over repositories
  • Write - Members can upload and download from the repository
  • Read - Members can download from the repository
  • None - Members have no repository access

Security

Organization Security is where you can enable Two-Factor Authentication. This will force members to set up Two-Factor Authentication for additional security.

Organization Security Settings


Team Settings

Organization Team settings are used to control the default visibility of teams:

Organization Team Settings

  • Visible - Non-Members are able to view the team
  • Hidden - Non-Members are not able to view the team

Package Settings

The Package settings are where you can configure storage and bandwidth limits for the Organization account, and view your current usage. It contains the following sections:

  • Usage Limits
  • Usage (Standard)
  • Usage (OSS)

Usage Limits

Usage Limits are where you configure the amount of overage allowed for the Organization. Overage is extra storage and bandwidth usage above what is included in your plan.

Package Usage Limits

πŸ“˜

Setting a limit of 0GB will disable any overage


Usage (Standard)

Usage (Standard) shows you how much storage and bandwidth the Organization has currently used for standard (private or public) repositories. Usage in green is included in your plan and usage in blue is any configured overage. You can also see the usage history:


Usage (OSS)

Usage (Standard) shows you how much storage and bandwidth the Organization has currently used for Open Source repositories.

Updated 7 months ago


Organizations


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


Cloudsmith: The new standard in Package Management and Software Distribution

With support for all major package formats, such as Docker. You can trust us to manage your package management for you.