Export a container through the Share tab and you will obtain a ‘.containds’ file that you can share with another ContainDS user so they can run your container on their machine.

This is an overview of the .containds file format.

The file is a simple ZIP file containing three files:

  • containds.json
  • environment.tar
  • workspace.tar

containds.json is a manifest file containing a JSON object like this:

{containds_version: 1.1, integrated: false, vendor_code: jupyter, presentation: true}

vendor_code will be ‘jupyter’ or ‘streamlit’ depending on the type of image available.

The presentation flag will be true if the intention is to run a ‘jupyter’ image as a Voila presentation.

environment.tar is a TAR archive of the Docker image used by the container.

If integrated in the manifest is true, the workspace will by definition be part of the Docker image. (This situation is not normally available in the latest versions of ContainDS.)

If integrated is false, the workspace will have been an external folder on your hard drive, in which case an extra file called workspace.tar will be present in the .containds ZIP file. The workspace.tar file is a TAR archive of that folder.

This is not guaranteed to be an exhaustive definition of the file format. For compatibility questions, please get in touch.