Public Collections
Learn how to set up Public Collections to share your organization's assets with the world.
Last updated
Was this helpful?
Learn how to set up Public Collections to share your organization's assets with the world.
Last updated
Was this helpful?
Public Collections provide a way to organize and share your organization's research assets with a global audience. Once enabled, you can create, organize, and refine your Collections prior to making them publicly available.
This is a paid feature. Enabling it may result in billing. Please reach out to your Customer Success Manager for clarification.
Using AWS Session Manager, connect to Code Ocean services instance:
Run the following command to enable the Public Collections feature:
Run the following command to view the current setting:
Once Public Collections has been enabled, you can customize the public-facing page with your organization's logo or image. To do so, go to the Public Collections page of the Admin Panel. Here, you can upload two images, one for light mode and one for dark mode.
Supported file types include: .png, .svg, .jpg, and image resolution requirement is 64 x 64.
The toggle on the Public Collections page determines whether your Public Collections are accessible to anyone with a URL. By default, sharing is turned off, allowing you to organize and manage your Public Collections privately.
When you're ready, toggle "Share Public Collections" ON to make your assets accessible publicly.
At any time, you can toggle "Share Public Collections" OFF to hide your Public Collections. This will not delete them; instead, they will be hidden from all and only visible to Code Ocean admins. You can continue to manage your Public Collections privately while they remain secure and hidden.
In the Collections Browser, you'll find two sections, one for Internal Collections and another for Public Collections.
To create a new Collection:
Navigate to the Collections Browser.
Click on the Collection where your new Collection will be nested in.
Click the plus sign.
Complete the fields:
Collection Name (required) — Use a meaningful name so that others can find the Collection easily.
Change the default icon (optional) — This will be the Collection's icon in the Collections Browser.
Change the default folder color (optional) — This will be the Collection's folder color on the Collections page.
Description (optional for internal, required for public) — Add some text to make the Collection easy to find and understand.
Click Create Collection to finish.
You can drag and drop Collections to reorganize them within the Collections Browser. However, this can only be done within the same section—Collections cannot be moved between 'Internal' and 'Public' sections.
Deleting an Internal Collection will remove all assets within it. The assets themselves will not be deleted.
A Public Collection can only be deleted if it is empty. Remove all assets prior to deleting a Public Collection.
Only admins can manage assets in Public Collections.
Click Manage Assets from the Collection's menu in the Collections Browser, or from the Collection page itself.
Find the asset you wish to add to the Public Collection by searching in the search bar, switching between asset types using the dropdown, and using the asset filters.
Click the plus sign to add an asset.
Confirm that you wish to Add to Public Collection.
Capsules, Pipelines, and No-Code Apps must be Release.
Data and Models must be public and external.
Combined Data must only contain public and external data.
See Change Data Asset Location API for more information on how to transfer Data Asset location to public.
Note that releasing a new version of a public Capsule or Pipeline will also publish the latest release to the public.