Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs with additions for windows specific installation #837

Merged
merged 1 commit into from
Jun 25, 2019
Merged

Update docs with additions for windows specific installation #837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 48 additions & 3 deletions docs/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,22 @@ To develop the platform you need to have docker and docker-compose running on yo
Installation
------------

1. Install Docker_ and `Docker Compose`_
1. Download and install Docker

*Linux*: Docker_ and `Docker Compose`_

*Windows 10 Pro (Build 15063 or later)*: `Docker for Windows`_

*Older Windows versions*: `Docker Toolbox`_

2. Clone the repo

.. code-block:: console

$ git clone https://github.com/comic/grand-challenge.org
$ cd grand-challenge.org

3. You can then start the site by invoking
3. You can then start the site by invoking

.. code-block:: console

Expand All @@ -41,6 +48,43 @@ Running Grand-Challenge within a Windows environment requires additional steps b

$ export COMPOSE_CONVERT_WINDOWS_PATHS=1

3. Add the following line to your hosts file (``C:\Windows\System32\drivers\etc\hosts``)

.. code-block:: console

# Using Docker for Windows:
127.0.0.1 gc.localhost

# Using Docker Toolbox:
192.168.99.100 gc.localhost


4. Share the drive where this repository is located with Docker

*Docker for Windows*

1. Right-click Docker icon in taskbar and click "Settings"
2. Go to "Shared drives" tab
3. Mark the checkbox of the drive where this repository is located

*Docker Toolbox*

1. Open VirtualBox
2. Go to the virtual machine that belongs to docker
3. Double click "Shared folders"
4. Click on the "Add New Shared Folder" button on the right
5. In the Folder Path box, type the drive letter where this repository is located (eg. ``C:\``)
6. In the Folder Name box, type the drive letter lowercased (eg. ``c``)
7. Restart the docker machine by typing ``docker-machine restart`` in your console
8. SSH into the docker VM with ``docker-machine ssh``
9. Append the following lines to the file ``/mnt/sda1/var/lib/boot2docker/profile``

.. code-block:: console

mkdir /home/docker/c # Change the 'c' to your drive letter
sudo mount -t vboxsf -o uid=1000,gid=50 c /home/docker/c # Again, change both 'c's to your drive letter



Running the Tests
-----------------
Expand Down Expand Up @@ -222,4 +266,5 @@ If you want to run this in a production environment you will need to make severa
.. _TravisCI: https://travis-ci.org/comic/grand-challenge.org
.. _Docker: https://docs.docker.com/install/
.. _`Docker Compose`: https://docs.docker.com/compose/install/

.. _`Docker for Windows`: https://docs.docker.com/docker-for-windows/install/
.. _`Docker Toolbox`: https://docs.docker.com/toolbox/toolbox_install_windows/