Skip to content

Commit

Permalink
adding vagrant doc and fixing indentation in vagrantfile
Browse files Browse the repository at this point in the history
  • Loading branch information
gramhagen authored and mhamilton723 committed Jul 29, 2019
1 parent d58d6f4 commit 3fe4db5
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 3 deletions.
44 changes: 44 additions & 0 deletions docs/vagrant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Using the MMLSpark Vagrant Image

## Install Vagrant and Dependencies

You will need to a few dependencies before we get started. These instructions are for using Vagrant on Windows OS.

1. Ensure [Hyper-V]((https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/) is enabled or install [Virtualbox](https://www.virtualbox.org/)
2. Install a X Server for Windows, [VcXsrv](https://sourceforge.net/projects/vcxsrv/) is a lightweight option.
3. Install the Vagrant version for your OS [here](https://www.vagrantup.com/downloads.html)

## Build the Vagrant Image

Start powershell as Administrator and go to the `mmlspark/tools/vagrant` directory and run

```
vagrant up
```

*Note: you may need to select a network switch, try the Default Switch option if possible*

## Connect to the Vagrant Image

First start the X-Window server (XLaunch if using VcXsrv).

From the same directory (with powershell as Administrator) run

```
$env:DISPLAY="localhost:0"
vagrant ssh -- -Y
# now you can start IntelliJ and interact with the GUI
> idea
```


## Stop the Vagrant Image

```
vagrant halt
```

## Further reading

This guide covers the bare minimum for running a Vagrant image. For more details see the [Vagrant Documentation](https://www.vagrantup.com/intro/index.html).
6 changes: 3 additions & 3 deletions tools/vagrant/Vagrantfile
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ SHELL

config.vm.provision "shell", privileged: false, inline: <<-SHELL
# Install mmlspark
cd ${HOME_DIR}
git clone https://github.com/Azure/mmlspark.git
cd mmlspark
cd ${HOME_DIR}
git clone https://github.com/Azure/mmlspark.git
cd mmlspark
sbt setup
SHELL

Expand Down

0 comments on commit 3fe4db5

Please sign in to comment.