diff --git a/README.rst b/README.rst index 764a308b8..f0918fe9f 100644 --- a/README.rst +++ b/README.rst @@ -9,18 +9,24 @@ Install for development Install: -- `VirtualBox `_ -- `Vagrant `_ -- `Ansible `_ (For Linux and Mac, install Ansible 2 via pip. For Windows(Windows isn’t supported for the control machine) go through `Ansible Documentation `_ or this `Blog `_.) +* `VirtualBox `_ + * Version 5.0.x +* `Vagrant `_ + * Version 1.8.1 + * If you are behind a proxy, you may need to install and configure the `vagrant-proxyconf `_ plugin +* `Ansible `_ + * Version 2.1.3.0 + * For Linux and Mac, install Ansible 2 via pip + * For Windows (unsupported), go through `Ansible Documentation `_ or this `blog `_ + +Clone the `repository `_ to your local machine and enter the cadasta-platform directory. +Run the following commands to access the virtual machine. -Clone the `repository `_ to your local machine and enter that directory. -After cloning it go inside to cadasta-platform directory and run below command to provision the virtual machine. Provision the VM:: vagrant up --provision -SSH into to the VM (this automatically activates the Python virtual -environment):: +SSH into the VM (automatically activates the Python virtual environment):: vagrant ssh @@ -29,7 +35,7 @@ Enter the cadasta directory and start the server:: cd cadasta ./runserver -Open ``http://localhost:8000/`` in your local machine's browser, this will forward you to the port on the VM and you should see the front page of the platform site. +Open ``http://localhost:8000/`` in your local machine's browser. This will forward you to the web server port on the VM and you should see the front page of the platform site. See the wiki (`here `_ and `here `_) for detailed instructions on installation and running the platform for development. diff --git a/Vagrantfile b/Vagrantfile index fcaab2ab7..cac3d76d6 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -2,6 +2,20 @@ # vi: set ft=ruby : Vagrant.configure(2) do |config| + if Vagrant.has_plugin?("vagrant-proxyconf") + if ENV["http_proxy"] + puts "http_proxy: " + ENV["http_proxy"] + config.proxy.http = ENV["http_proxy"] + end + if ENV["https_proxy"] + puts "https_proxy: " + ENV["https_proxy"] + config.proxy.https = ENV["https_proxy"] + end + if ENV["no_proxy"] + config.proxy.no_proxy = ENV["no_proxy"] + end + end + config.vm.box = "ubuntu/trusty64" config.vm.network "forwarded_port", guest: 8000, host: 8000 @@ -11,7 +25,7 @@ Vagrant.configure(2) do |config| end config.vm.provision "ansible" do |ansible| -# ansible.verbose = "vvv" + # ansible.verbose = "vvv" ansible.playbook = "provision/vagrant.yml" end