diff --git a/README.md b/README.md index 885db3cd7c..82a82221f5 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,8 @@ Table of Contents - [Dependencies](#dependencies) - [Building](#building) - [Launching](#launching) - - [Docker](#docker) + - [Vagrant](#vagrant) + - [Docker](#docker) - [Help!](#help) - [Configuration](#configuration) - [Modifying CSS](#modifying-css) @@ -105,8 +106,6 @@ running `make`, then add for more information](http://stackoverflow.com/a/22355874/347246)): $ ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future - - Building -------- @@ -200,12 +199,19 @@ Vagrant ------- If you have vagrant installed, you can run gittip by running `vagrant up` from the project directory. Please note that if you ever switch between running gittip on your own machine to vagrant or vice versa, you will need to run `make clean`. +If you're using Vagrant for the first time you'll need [Vagrant](http://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) installed. If you're on Linux you'll need to install `nfs-kernel-server`. + The Vagrantfile will download a custom made image from the internet. If you have a slow internet connection, you can download a local copy of this file, by running: `curl http://downloads.gittipllc.netdna-cdn.com/gittip.box` Once downloaded, vagrant will use this local file automatically when you run `vagrant up`. Vagrant is setup to use key based SSH authentication, if you're prompted for a password please use `vagrant`. +**Ubuntu users:** If you experience problems, please see [this +issue](https://github.com/gittip/www.gittip.com/pull/2321#issuecomment-41455169). +As mentioned, you will also need to be wary of projects that are nested +in encrypted directories. + Docker ------------ diff --git a/Vagrantfile b/Vagrantfile index ebba320255..8906b2718c 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -20,7 +20,8 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| config.vm.box_url = File.exist?("gittip.box") ? "file://gittip.box" : "http://downloads.gittipllc.netdna-cdn.com/gittip.box" # Sync the project directory and expose the app - config.vm.synced_folder ".", "/home/vagrant/#{PROJECT_DIRECTORY}" + config.vm.network "private_network", ip: "172.27.36.119" + config.vm.synced_folder ".", "/home/vagrant/#{PROJECT_DIRECTORY}", type: "nfs" config.vm.network :forwarded_port, guest: 8537, host: 8537 # TODO: Pin apt-get packages to the same versions Heroku uses