Create an environment

How to create a new custom environment from a Docker build script

Step-by-step tutorial

  1. Navigate to the creation page via Analysis β†’ Environments β†’ Create Environment
  2. Enter environment details such as title, description, and intended scientific technique:
  3. On the next page, click CREATE SCRIPT:
  4. Write (or copy-paste) a Docker build script into the editor, keeping the following in mind:
    1. Currently, only ubuntu:22.04 and ubuntu:24.04 are available as a base image
    2. If you upload a supporting file, script.sh, you can copy the file into the container from the ./script.sh location
    3. Note that the ENV command will set an environment variable while the environment is created, but it will not be set in a session started with this environment. E.g., to /your/dir on PATH, it is recommended to use both 
      • ENV PATH=$PATH:/your/dir and
      • RUN echo 'export PATH=$PATH:/your/dir' >> /etc/profile
    4. Do NOT add any files to /app or /work as those directories will not be accessible when running a job.
  5. On the next page, review your environment configuration and click START BUILD:
  6. On the build confirmation page, you can either wait for the environment build to finish to review the build output:or you can navigate to the environments overview table at Environments β†’ Environments, choose your newly created environment, and review the build output from there:      
  7. Environments can be used personally for starting sessions with specific configurations and/or launching jobs. They can also be shared with collaborators. Before sharing an environment, make sure you have the rights to redistribute any software within it. 

CloudPlay

References

[1] https://xds.mr.mpg.de/

[2] https://github.com/dectris/neggia

Was this article helpful?