Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Xavier Antoviaque
2013-07-01 13:48:50 -03:00
committed by David Baumgold
parent 214734d1dc
commit 055ef6e1aa
1 changed files with 13 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -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 process.
1. Install Git: http://git-scm.com/downloads
2. Install VirtualBox: https://www.virtualbox.org/wiki/Downloads
3. Install Vagrant: http://www.vagrantup.com/ (Vagrant 1.2.2 or later)
4. Open a terminal
5. Download the project: `git clone git://github.com/edx/edx-platform.git`
6. Enter the project directory: `cd edx-platform/`
7. Start: `vagrant up`
1. Make sure you have plenty of available disk space, >5GB
2. Install Git: http://git-scm.com/downloads
3. Install VirtualBox: https://www.virtualbox.org/wiki/Downloads (VirtualBox 4.2.14
or later)
4. Install Vagrant: http://www.vagrantup.com/ (Vagrant 1.2.2 or later)
5. Open a terminal
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.
@@ -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.
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
----------------
@@ -91,34 +94,8 @@ $ vagrant up --no-provision
Troubleshooting
---------------
### Reinstalling
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
```
If anything doesn't work as expected, see the
[troubleshooting section](https://github.com/edx/edx-platform/wiki/Simplified-install-with-vagrant#troubleshooting).
Installation - Advanced
=======================