For the complete documentation index, see llms.txt. This page is also available as Markdown.
Sharing a Capsule with Secrets
You can share and Release a Capsule with secrets just like any other Capsule. The considerations and instructions for using shared Capsules with secrets are below.
Running a Shared Capsule with Required Secrets
Run a Shared Capsule with Missing Credentials
If you try to execute a Reproducible Run in Capsule that requires secrets and the secrets are not set, a warning message will pop up.
Code Ocean will still allow you to execute a Reproducible Run. However, if you don't fix the credentials, the results are likely not reproducible.
Check if Secrets are Required
When using other users' Capsules, it is a good habit to check if the Capsule requires secrets.
Click on environment to display the Environment Editor.
Scroll down to see the Secrets section.
Check if there is a secret to fill.
The screenshot demonstrates a Capsule that requires AWS credentials and a custom key:
Add Your Secret to a Shared Capsule
Click on the drop-down menu to select the secret to attach from your account.
The list in the drop-down is filtered and only shows the specific type of secret in your account.
If you don't have existing credentials to attach, the + Add New [secret type] button allows you to add a new secret:
The system will pop up a form for you to fill out the details depending on the secret type.
The system will store the newly added secret to your account.
