Merge pull request #2886 from rabuzarus/0311_fix_photo_albums

[friendica.git] / doc / Vagrant.md

diff --git a/doc/Vagrant.md b/doc/Vagrant.md
index dec8112edcd2a0b9cc82e8df3dd0421c825e5ea8..4bc9e6c54d985ba3f57a0dd6711eed42afb8e64c 100644 (file)
--- a/doc/Vagrant.md
+++ b/doc/Vagrant.md
@@ -3,13 +3,51 @@ Vagrant for Friendica Developers
 
 * [Home](help)
 
 
 * [Home](help)
 

-[Vagrant](https://www.vagrantup.com/) is a virtualization solution for developers. No need to setup up a webserver, database etc. before actually starting. Vagrant creates a virtual machine (an Ubuntu 12.04) for you that you can just run inside VirtualBox and start to work directly on Friendica. What you need to do:
+Getting started
+---------------
+
+[Vagrant](https://www.vagrantup.com/) is a virtualization solution for developers.
+No need to setup up a webserver, database etc. before actually starting.
+Vagrant creates a virtual machine (an Ubuntu 14.04) for you that you can just run inside VirtualBox and start to work directly on Friendica.
+
+What you need to do:

 
 1. Install VirtualBox and vagrant.
 
 1. Install VirtualBox and vagrant.

-2. Git clone your Friendica repository. Inside, you'll find a "Vagrantfile" and some scripts in the utils folder.
-3. Run "vagrant up" from inside the friendica clone. Be patient: When it runs for the first time, it downloads an Ubuntu Server image.
+Please use an up-to-date vagrant version from https://www.vagrantup.com/downloads.html.
+2. Git clone your Friendica repository.
+Inside, you'll find a "Vagrantfile" and some scripts in the utils folder.
+3. Run "vagrant up" from inside the friendica clone.
+Be patient: When it runs for the first time, it downloads an Ubuntu Server image.

 4. Run "vagrant ssh" to log into the virtual machine to log in to the VM.
 4. Run "vagrant ssh" to log into the virtual machine to log in to the VM.

-5. Open 192.168.22.10 in a browser to finish the Friendica installation. The mysql database is called "friendica", the mysql user and password both are "root".
+5. Open 192.168.22.10 in a browser.
+The mysql database is called "friendica", the mysql user and password both are "root".

 6. Work on Friendica's code in your git clone on your machine (not in the VM).
 6. Work on Friendica's code in your git clone on your machine (not in the VM).

-7. Check the changes in your browser in the VM. Debug via the "vagrant ssh" login.
+Your local working directory is set up as a shared directory with the VM (/vagrant).
+7. Check the changes in your browser in the VM.
+Debug via the "vagrant ssh" login.
+Find the Friendica log file /vagrant/logfile.out.

 8. Commit and push your changes directly back to Github.
 8. Commit and push your changes directly back to Github.

+
+If you want to stop vagrant after finishing your work, run the following command
+
+               $> vagrant halt
+
+in the development directory.
+
+The vagrant Friendica instance contains a test database.
+You will then have the following accounts to login:
+
+  * admin, password admin
+  * friendica1, password friendica1
+  * friendica2, password friendica2 and so on until friendica5
+  * friendica1 is connected to all others. friendica1 has two groups: group1 with friendica2 and friendica4, group2 with friendica3 and friendica5.
+  * friendica2 and friendica3 are conntected. friendica4 and friendica5 are connected. 
+
+For further documentation of vagrant, please see [the vagrant*docs*](https://docs.vagrantup.com/v2/).
+
+**Important notice:**
+If you already had an Ubuntu 12.04 Vagrant VM, please run 
+
+       $> vagrant destroy
+
+before starting the new 14.04 machine.