Post-Deployment Configuration

Learn how to prepare your deployment prior to onboarding and inviting new users.

Create an Admin Account

Once your Code Ocean VPC instance has been deployed, you'll need to create the initial admin account.

Go to https://[hostname]/join to create an admin account as shown below:

Authentication

Built-in authentication with username and password is enabled by default on new deployments. If you wish to use SAML SSO or OIDC for authentication instead of/in addition to built-in authentication, these methods can be configured in the Admin Panel.

Please see Authentication for details.

Deploy Base Images (Starter Environments)

Before inviting users to your Code Ocean VPC instance, we recommend first deploying base images to provide users with Capsule Starter Environments. The platform comes bundled with a selection of "recommended" Starter Environments for the most common use cases. Custom Docker base images that contain software/packages relevant to specific analyses can also be brought into the platform.

Please see Starter Environments for details.

Git Provider Integration

Configure Git Provider integration to allow users to sync their existing git repositories with Code Ocean as Capsules and Pipelines.

Please see Enable Git Integration for details.

AWS Assumable Roles

If data is stored on S3, we recommend integrating your IdP with Code Ocean and assigning AWS IAM roles to the relevant users and/or groups. Upon login, Code Ocean assumes the roles on the user's behalf, enabling access to the resources defined in the IAM role policy without requiring the use of individual personal access keys/tokens.

Please see Assumable Roles for details.

Custom Metadata

Define Custom Metadata Keys for Data Assets to improve data findability and organization. Admins can enforce a standardized vocabulary by making specified Custom Metadata Keys mandatory for Data Asset creation.

Please see Custom Metadata for details.

Optional: For the purposes of providing support and/or to help facilitate new user onboarding, Code Ocean support staff members can be invited to your VPC deployment. By default, we have no access to your deployment.