Commit 055ef6e1 by Xavier Antoviaque Committed by David Baumgold

vagrant: Update README (QA, link to wiki & disk space requirement)

parent 214734d1
...@@ -10,13 +10,15 @@ with a minimal amount of steps, using Vagrant. It is recommended for a first ...@@ -10,13 +10,15 @@ with a minimal amount of steps, using Vagrant. It is recommended for a first
installation, as it will save you from many of the common pitfalls of the installation, as it will save you from many of the common pitfalls of the
installation process. installation process.
1. Install Git: http://git-scm.com/downloads 1. Make sure you have plenty of available disk space, >5GB
2. Install VirtualBox: https://www.virtualbox.org/wiki/Downloads 2. Install Git: http://git-scm.com/downloads
3. Install Vagrant: http://www.vagrantup.com/ (Vagrant 1.2.2 or later) 3. Install VirtualBox: https://www.virtualbox.org/wiki/Downloads (VirtualBox 4.2.14
4. Open a terminal or later)
5. Download the project: `git clone git://github.com/edx/edx-platform.git` 4. Install Vagrant: http://www.vagrantup.com/ (Vagrant 1.2.2 or later)
6. Enter the project directory: `cd edx-platform/` 5. Open a terminal
7. Start: `vagrant up` 6. Download the project: `git clone git://github.com/edx/edx-platform.git`
7. Enter the project directory: `cd edx-platform/`
8. Start: `vagrant up`
The last step might require your administrator password to setup NFS. The last step might require your administrator password to setup NFS.
...@@ -24,7 +26,8 @@ Afterwards, it will download an image, install all the dependencies and configur ...@@ -24,7 +26,8 @@ Afterwards, it will download an image, install all the dependencies and configur
the VM. It will take a while, go grab a coffee. the VM. It will take a while, go grab a coffee.
Once completed, hopefully you should see a "Success!" message indicating that the Once completed, hopefully you should see a "Success!" message indicating that the
installation went fine. (If not, refer to the Troubleshooting section below.) installation went fine. (If not, refer to the
[troubleshooting section](https://github.com/edx/edx-platform/wiki/Simplified-install-with-vagrant#troubleshooting).)
Accessing the VM Accessing the VM
---------------- ----------------
...@@ -91,34 +94,8 @@ $ vagrant up --no-provision ...@@ -91,34 +94,8 @@ $ vagrant up --no-provision
Troubleshooting Troubleshooting
--------------- ---------------
### Reinstalling If anything doesn't work as expected, see the
[troubleshooting section](https://github.com/edx/edx-platform/wiki/Simplified-install-with-vagrant#troubleshooting).
If something goes wrong, you can easily recreate the installation from scratch by
typing:
```
$ vagrant destroy -f && vagrant up
```
This will delete the current VM, create a new VM, re-install all the dependencies,
and reconfigure.
### "Mounting NFS shared folders failed"
If you get the following error message when you run `$ vagrant up`:
```
It appears your machine doesn't support NFS, or there is not an
adapter to enable NFS on this machine for Vagrant. Please verify
that `nfsd` is installed on your machine, and try again. If you're
on Windows, NFS isn't supported.
```
You need to install NFS. Under Debian/Ubuntu, for example:
```
$ sudo apt-get install nfs-common nfs-kernel-server
```
Installation - Advanced Installation - Advanced
======================= =======================
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment