<commit_before>---
title: "Launch local Vagrant based Logsearch Workspace VM"
---

The instructions below walk through setting up a local Logsearch Workspace VM based on Vagrant and Virtualbox:

0. You need to have installed:
    * Git 1.8+
    * Vagrant 1.6.5+
    * VirtualBox 4.3.18+
    * A SSH client

0. Installing above dependancies 
    * on Windows

        We recommend you use the [Chocolatey](https://chocolatey.org/) package manager to install the above dependancies on  Windows
        
        Open an _Administrative PowerShell_ prompt and:
        
            iex ((new-object net.webclient).DownloadString('https://chocolatey.org/install.ps1')) # Installs Chocolatey
            choco install git         # Installs git AND a ssh client
            choco install virtualbox  # Installs VirtualBox
            choco install vagrant     # Installs Vagrant

    * on Mac OSX

        We recommend you use the [Homebrew](http://brew.sh/) package manager to install the above dependancies on Mac
        
        Open an terminal and:
        
            ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" # Installs HomeBrew
            brew install git                       #installs git
            brew install caskroom/cask/brew-cask   # homebrew-cask manages binary apps with HomeBrew
            brew cask install virtualbox           # Installs VirtualBox
            brew cask install vagrant              # Installs Vagrant

0. Launch a Vagrant VM (This downloads [a custom Vagrant box of approx 1.4GB in size from AWS S3](https://github.com/Logsearch/workspace/blob/master/Vagrantfile#L12))

        git clone https://github.com/logsearch/workspace ~/logsearch-workspace
        cd ~/logsearch-workspace
        vagrant up
          
0. SSH into your workspace
    * Using the default SSH client: `vagrant ssh`
    * In case you want to use a custom SSH client (eg, Putty/Kitty on Windows), you can get the SSH settings needed using ``vagrant ssh-config`
    * You should see something like:

             $ vagrant ssh
             Welcome to Ubuntu 14.04 LTS (GNU/Linux 3.13.0-37-generic x86_64)
             
              * Documentation:  https://help.ubuntu.com/
             +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+
             |L|o|g|S|e|a|r|c|h| |W|o|r|k|s|p|a|c|e|
             +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+
             
             ├── bin
             │   └── setup_sub_projects               <--- run this to populate your environments/ and src/ folders
             ├── environments                         <--- configuration for the environments you manage goes here<commit_msg>Document that on Windows vagrant up *must* be run from an Administrative console<commit_after>---
title: "Launch local Vagrant based Logsearch Workspace VM"
---

The instructions below walk through setting up a local Logsearch Workspace VM based on Vagrant and Virtualbox:

0. You need to have installed:
    * Git 1.8+
    * Vagrant 1.6.5+
    * VirtualBox 4.3.18+
    * A SSH client

0. Installing above dependancies 
    * on Windows

        We recommend you use the [Chocolatey](https://chocolatey.org/) package manager to install the above dependancies on  Windows
        
        Open an _Administrative PowerShell_ prompt and:
        
            iex ((new-object net.webclient).DownloadString('https://chocolatey.org/install.ps1')) # Installs Chocolatey
            choco install git         # Installs git AND a ssh client
            choco install virtualbox  # Installs VirtualBox
            choco install vagrant     # Installs Vagrant

    * on Mac OSX

        We recommend you use the [Homebrew](http://brew.sh/) package manager to install the above dependancies on Mac
        
        Open an terminal and:
        
            ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" # Installs HomeBrew
            brew install git                       #installs git
            brew install caskroom/cask/brew-cask   # homebrew-cask manages binary apps with HomeBrew
            brew cask install virtualbox           # Installs VirtualBox
            brew cask install vagrant              # Installs Vagrant

0. Launch a Vagrant VM (This downloads [a custom Vagrant box of approx 1.4GB in size from AWS S3](https://github.com/Logsearch/workspace/blob/master/Vagrantfile#L12))

    * _NB! On Windows you must run this from an Administrative console prompt_

        git clone https://github.com/logsearch/workspace ~/logsearch-workspace
        cd ~/logsearch-workspace
        vagrant up
          
0. SSH into your workspace
    * Using the default SSH client: `vagrant ssh`
    * In case you want to use a custom SSH client (eg, Putty/Kitty on Windows), you can get the SSH settings needed using ``vagrant ssh-config`
    * You should see something like:

             $ vagrant ssh
             Welcome to Ubuntu 14.04 LTS (GNU/Linux 3.13.0-37-generic x86_64)
             
              * Documentation:  https://help.ubuntu.com/
             +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+
             |L|o|g|S|e|a|r|c|h| |W|o|r|k|s|p|a|c|e|
             +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+
             
             ├── bin
             │   └── setup_sub_projects               <--- run this to populate your environments/ and src/ folders
             ├── environments                         <--- configuration for the environments you manage goes here
{'fraction_non_alphanumeric': 0.10129349608307524, 'fraction_numerical': 0.012024048096192385, 'mean_word_length': 1.9885683179096352, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 3, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3427125', 'n_tokens_mistral': 1616, 'n_tokens_neox': 1487, 'n_words': 529}