From 977e413d42f18eacb40e7720822c811a8b6ad32b Mon Sep 17 00:00:00 2001 From: Sam Walton Date: Thu, 17 Jan 2019 13:54:11 +0000 Subject: [PATCH 1/4] First basic step-by-step for testing with Aaron --- docs/step_by_step.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/step_by_step.md diff --git a/docs/step_by_step.md b/docs/step_by_step.md new file mode 100644 index 0000000..5b389ee --- /dev/null +++ b/docs/step_by_step.md @@ -0,0 +1,18 @@ +# Step by step guide for installing twlight_vagrant + +## Windows via WSL + +This method, the recommended way to run the environment on Windows, makes use of [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10). + +1. Install [Vagrant for Windows](https://www.vagrantup.com/downloads.html) +2. Install [VirtualBox for Windows, along with the VirtualBox Extension Pack](https://www.virtualbox.org/wiki/Downloads) +3. Follow [this guidance](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)) to add `C:\Program Files\Oracle\VirtualBox` to the PATH environment variable. +4. Ensure that you're on Windows 10 Version 1709 or later and install Windows Subsystem for Linux via the [Microsoft Store](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6). +5. Download the [Vagrant for Debian](https://www.vagrantup.com/downloads.html) (making sure this is the same version you installed on Windows) +6. Open Ubuntu and install Vagrant with `dpkg -i [vagrant_file_name.deb]` +7. Install the vbguest plugin with `vagrant plugin install vagrant-vbguest` +8. Run `export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"` to enable WSL to access Windows files. +9. Do `vagrant up`. If everything has gone smoothly this should complete without errors. +10. You can now ssh into vagrant with `vagrant ssh -- -D 2080` +11. To view the site you will need to configure your browser to hit a SOCKS proxy on this port. Instructions for setting up FoxyProxy for this can be found at [foxyproxy.md](https://github.com/WikipediaLibrary/twlight_vagrant/blob/master/docs/foxyproxy.md). +12. For file management, a number of FTP guides can be found at [host_side_file_management.md](https://github.com/WikipediaLibrary/twlight_vagrant/blob/master/docs/host_side_file_management.md) From 91b8d93f49742328fc563169f7f46d29daca6324 Mon Sep 17 00:00:00 2001 From: Sam Walton Date: Thu, 17 Jan 2019 14:52:23 +0000 Subject: [PATCH 2/4] Add git clone step with note about Windows directory --- docs/step_by_step.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/step_by_step.md b/docs/step_by_step.md index 5b389ee..8c6e37a 100644 --- a/docs/step_by_step.md +++ b/docs/step_by_step.md @@ -8,11 +8,12 @@ This method, the recommended way to run the environment on Windows, makes use of 2. Install [VirtualBox for Windows, along with the VirtualBox Extension Pack](https://www.virtualbox.org/wiki/Downloads) 3. Follow [this guidance](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)) to add `C:\Program Files\Oracle\VirtualBox` to the PATH environment variable. 4. Ensure that you're on Windows 10 Version 1709 or later and install Windows Subsystem for Linux via the [Microsoft Store](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6). -5. Download the [Vagrant for Debian](https://www.vagrantup.com/downloads.html) (making sure this is the same version you installed on Windows) -6. Open Ubuntu and install Vagrant with `dpkg -i [vagrant_file_name.deb]` -7. Install the vbguest plugin with `vagrant plugin install vagrant-vbguest` -8. Run `export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"` to enable WSL to access Windows files. -9. Do `vagrant up`. If everything has gone smoothly this should complete without errors. -10. You can now ssh into vagrant with `vagrant ssh -- -D 2080` -11. To view the site you will need to configure your browser to hit a SOCKS proxy on this port. Instructions for setting up FoxyProxy for this can be found at [foxyproxy.md](https://github.com/WikipediaLibrary/twlight_vagrant/blob/master/docs/foxyproxy.md). -12. For file management, a number of FTP guides can be found at [host_side_file_management.md](https://github.com/WikipediaLibrary/twlight_vagrant/blob/master/docs/host_side_file_management.md) +5. `git clone https://github.com/wikipedialibrary/twlight_vagrant` into a windows directory (e.g. `mnt/c/Users/Sam/twlight_vagrant`) +6. Download the [Vagrant for Debian](https://www.vagrantup.com/downloads.html) (making sure this is the same version you installed on Windows) +7. Open Ubuntu and install Vagrant with `dpkg -i [vagrant_file_name.deb]` +8. Install the vbguest plugin with `vagrant plugin install vagrant-vbguest` +9. Run `export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"` to enable WSL to access Windows files. +10. Do `vagrant up`. If everything has gone smoothly this should complete without errors. +11. You can now ssh into vagrant with `vagrant ssh -- -D 2080` +12. To view the site you will need to configure your browser to hit a SOCKS proxy on this port. Instructions for setting up FoxyProxy for this can be found at [foxyproxy.md](https://github.com/WikipediaLibrary/twlight_vagrant/blob/master/docs/foxyproxy.md). +13. For file management, a number of FTP guides can be found at [host_side_file_management.md](https://github.com/WikipediaLibrary/twlight_vagrant/blob/master/docs/host_side_file_management.md) From cb7d34767a068b6cb7a8dff85b6d7177d6fe15df Mon Sep 17 00:00:00 2001 From: Sam Walton Date: Thu, 17 Jan 2019 15:01:41 +0000 Subject: [PATCH 3/4] Add some issues and solutions --- docs/step_by_step.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/step_by_step.md b/docs/step_by_step.md index 8c6e37a..09e863a 100644 --- a/docs/step_by_step.md +++ b/docs/step_by_step.md @@ -10,10 +10,24 @@ This method, the recommended way to run the environment on Windows, makes use of 4. Ensure that you're on Windows 10 Version 1709 or later and install Windows Subsystem for Linux via the [Microsoft Store](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6). 5. `git clone https://github.com/wikipedialibrary/twlight_vagrant` into a windows directory (e.g. `mnt/c/Users/Sam/twlight_vagrant`) 6. Download the [Vagrant for Debian](https://www.vagrantup.com/downloads.html) (making sure this is the same version you installed on Windows) -7. Open Ubuntu and install Vagrant with `dpkg -i [vagrant_file_name.deb]` +7. Open Ubuntu and install Vagrant from that downloaded file with `dpkg -i [vagrant_file_name.deb]` 8. Install the vbguest plugin with `vagrant plugin install vagrant-vbguest` 9. Run `export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"` to enable WSL to access Windows files. 10. Do `vagrant up`. If everything has gone smoothly this should complete without errors. 11. You can now ssh into vagrant with `vagrant ssh -- -D 2080` 12. To view the site you will need to configure your browser to hit a SOCKS proxy on this port. Instructions for setting up FoxyProxy for this can be found at [foxyproxy.md](https://github.com/WikipediaLibrary/twlight_vagrant/blob/master/docs/foxyproxy.md). 13. For file management, a number of FTP guides can be found at [host_side_file_management.md](https://github.com/WikipediaLibrary/twlight_vagrant/blob/master/docs/host_side_file_management.md) + +## Potential issues + +### Vagrant will not operate outside the Windows Subsystem for Linux unless explicitly instructed + +You probably missed step 9 above - `export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"` + +### VT-x is disabled in the BIOS for both all CPU modes + +You may need to go into your BIOS and enable Virtualisation or VT-x settings. You can follow a guide [such as this one](https://www.howtogeek.com/213795/how-to-enable-intel-vt-x-in-your-computers-bios-or-uefi-firmware/) to find the correct setting. + +### Host path of the shared folder must be located on a file system with DrvFs type + +This may appear if you are trying to `vagrant up` while in an Ubuntu directory (e.g. /home/Sam/twlight_vagrant). Try cloning to a Windows directory (e.g. `mnt/c/Users/Sam/twlight_vagrant`). From eb72a4cdb935a0714c5eaab79e199616193de2aa Mon Sep 17 00:00:00 2001 From: Sam Walton Date: Thu, 17 Jan 2019 15:06:31 +0000 Subject: [PATCH 4/4] Fix a couple of the messages and clarify download directory --- docs/step_by_step.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/step_by_step.md b/docs/step_by_step.md index 09e863a..a46824f 100644 --- a/docs/step_by_step.md +++ b/docs/step_by_step.md @@ -10,7 +10,7 @@ This method, the recommended way to run the environment on Windows, makes use of 4. Ensure that you're on Windows 10 Version 1709 or later and install Windows Subsystem for Linux via the [Microsoft Store](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6). 5. `git clone https://github.com/wikipedialibrary/twlight_vagrant` into a windows directory (e.g. `mnt/c/Users/Sam/twlight_vagrant`) 6. Download the [Vagrant for Debian](https://www.vagrantup.com/downloads.html) (making sure this is the same version you installed on Windows) -7. Open Ubuntu and install Vagrant from that downloaded file with `dpkg -i [vagrant_file_name.deb]` +7. Open Ubuntu and install Vagrant from that downloaded file with `dpkg -i [vagrant_file_name.deb]`. If you downloaded the file in Windows, you can navigate to the C: drive via `/mnt/c`. 8. Install the vbguest plugin with `vagrant plugin install vagrant-vbguest` 9. Run `export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"` to enable WSL to access Windows files. 10. Do `vagrant up`. If everything has gone smoothly this should complete without errors. @@ -24,10 +24,10 @@ This method, the recommended way to run the environment on Windows, makes use of You probably missed step 9 above - `export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"` -### VT-x is disabled in the BIOS for both all CPU modes +### VT-x is disabled in the BIOS for all CPU modes You may need to go into your BIOS and enable Virtualisation or VT-x settings. You can follow a guide [such as this one](https://www.howtogeek.com/213795/how-to-enable-intel-vt-x-in-your-computers-bios-or-uefi-firmware/) to find the correct setting. -### Host path of the shared folder must be located on a file system with DrvFs type +### The host path of the shared folder is not supported from WSL This may appear if you are trying to `vagrant up` while in an Ubuntu directory (e.g. /home/Sam/twlight_vagrant). Try cloning to a Windows directory (e.g. `mnt/c/Users/Sam/twlight_vagrant`).