Skip to content

Commit

Permalink
Update docker documentation (#6)
Browse files Browse the repository at this point in the history
* update dockerfile and docs
  • Loading branch information
efieremans authored Feb 17, 2024
1 parent 20cc4d3 commit 4df25f2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ ENV LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/mrtrix3/src:/usr/local/mrtrix3/c
RUN echo ". /usr/local/fsl/etc/fslconf/fsl.sh" >> /root/.bashrc
ENV PYTHONPATH=/usr/local/mrtrix3/build/lib

RUN sh -c "$(wget -O- https://github.com/deluan/zsh-in-docker/releases/download/v1.1.5/zsh-in-docker.sh)" -- \
-p git -p ssh-agent -p 'history-substring-search' \
-a 'bindkey "\$terminfo[kcuu1]" history-substring-search-up' \
-a 'bindkey "\$terminfo[kcud1]" history-substring-search-down'




5 changes: 2 additions & 3 deletions docs/docs/designer/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,12 @@ nav_order: 1
We provide convenient docker images to quickly get started with Designer. The latest version will be published on [Docker Hub](https://hub.docker.com/repository/docker/nyudiffusionmri/designer2/general).
Official versions will be tagged (nyudiffusionmri/designer2:<tag>), while we also maintain images following our main development branch (nyudiffusionmri/designer2:main).

To get started, install Docker on your machine:
- https://www.docker.com/products/docker-desktop/
To get started, install [Docker Desktop](https://www.docker.com/products/docker-desktop/) on your machine.


Verifying can be done by running `docker run nyudiffusionmri/designer2:main designer`

You can also start an interactive terminal in your container by running `docker -it run nyudiffusionmri/designer2:main /bin/bash`
You can then start an interactive terminal in your container by running `docker run -it nyudiffusionmri/designer2:main /bin/bash`

Files can be passed by mounting a local folder into the container: `docker run -it -v <path to local folder>:/data nyudiffusionmri/designer2:main /bin/bash`. In this case you can run commands in the container directly.

Expand Down

0 comments on commit 4df25f2

Please sign in to comment.