Skip to content
This repository has been archived by the owner on Sep 24, 2021. It is now read-only.

Lr/update readme #46

Merged
merged 5 commits into from
Jan 15, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Installation

.. code:: sh

docker pull neuropoly/sct:sct-4.0.0-official
docker pull neuropoly/sct:latest

Note: to list all available images on the registery, please see `Generation and distribution`_.

Expand All @@ -87,7 +87,7 @@ Installation

.. code:: sh

docker load --input sct-4.0.0-official.tar
docker load --input latest.tar

**Note:** After the --input parameter you can include the complete
path where the docker image is located.
Expand Down Expand Up @@ -140,13 +140,13 @@ Usage

.. code:: sh

docker run -p 2222:22 --rm -it -v c:/Users/docker_shared_folder://home/sct/docker_shared_folder neuropoly/sct:sct-4.0.0-official
docker run -p 2222:22 --rm -it -v c:/Users/docker_shared_folder://home/sct/docker_shared_folder neuropoly/sct:latest

- If running Docker Toolbox, open Docker Quickstart Terminal, wait until get a prompt and write:

.. code:: sh

docker run -p 2222:22 --rm -it -v //c/Users/docker_shared_folder://home/sct/docker_shared_folder neuropoly/sct:sct-4.0.0-official
docker run -p 2222:22 --rm -it -v //c/Users/docker_shared_folder://home/sct/docker_shared_folder neuropoly/sct:latest

**Note:** The folder ``C:/Users/docker_shared_folder`` on the
Windows host system will be linked to the folder
Expand Down Expand Up @@ -254,7 +254,7 @@ Usage

.. code:: sh

docker run -p 2222:22 --rm -it -v /home/docker/docker_shared_folder://home/sct/docker_shared_folder neuropoly/sct:sct-4.0.0-official
docker run -p 2222:22 --rm -it -v /home/docker/docker_shared_folder://home/sct/docker_shared_folder neuropoly/sct:latest

- Check if the Docker shared folder is highlighted in green:

Expand Down Expand Up @@ -357,13 +357,13 @@ Installation

.. code:: sh

docker pull neuropoly/sct:sct-4.0.0-official
docker pull neuropoly/sct:latest

- Else, load the SCT image from a local file

.. code:: sh

docker load --input sct-4.0.0-official.tar
docker load --input latest-offline.tar

#. If you are on OSX and you need X forwarding (e.g. to run FSLeyes from the ssh window), install `Xquartz <https://www.xquartz.org/>`_.
After installing Xquartz and after rebooting, run this command to prevent `this issue <https://github.com/neuropoly/sct_docker/issues/29>`_:
Expand All @@ -388,7 +388,7 @@ Usage

.. code:: sh

docker run -p 2222:22 --rm -it -v ~/docker_shared_folder://home/sct/docker_shared_folder neuropoly/sct:sct-4.0.0-official
docker run -p 2222:22 --rm -it -v ~/docker_shared_folder://home/sct/docker_shared_folder neuropoly/sct:latest


#. (NOT MANDATORY) Change the password (default is `sct`) from the container prompt:
Expand Down Expand Up @@ -419,13 +419,13 @@ Usage
.. code:: sh

cd $HOME
tar xf /path/to/sct-4.0.0-official-offline.tar.xz
tar xf /path/to/latest.tar.xz

#. Add PATH:

.. code:: sh

PATH+=":/home/sct/sct_4.0.0/bin"
PATH+=":/home/sct/latest/bin"

#. Use it!

Expand Down Expand Up @@ -464,24 +464,24 @@ List all available images in the registery (you will need `wget` for this to wor

wget -q https://registry.hub.docker.com/v1/repositories/neuropoly/sct/tags -O - | sed -e 's/[][]//g' -e 's/"//g' -e 's/ //g' | tr '}' '\n' | awk -F: '{print $3}'

Example: creation of all distros container images:
Example: creation of all distros container images for a specific version:

.. code:: sh

./sct_docker_images.py generate --version 4.0.0
./sct_docker_images.py generate --version 4.2.1

Example: creation of offline archive tarball:

.. code:: sh

./sct_docker_images.py generate --version 4.0.0 --distros ubuntu:18.04 --generate-distro-specific-sct-tarball
./sct_docker_images.py generate --version 4.2.1 --distros ubuntu:18.04 --generate-distro-specific-sct-tarball

Example: creation and distribution:

.. code:: sh

docker login # Make sure your account has push permission on neuropoly organization
./sct_docker_images.py generate --version 4.0.0 --publish-under neuropoly/sct
./sct_docker_images.py generate --version 4.2.1 --publish-under neuropoly/sct


Notes
Expand Down