friendica-github/doc/Vagrant.md

Vagrant for Friendica Developers
===================

* [Home](help)

**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 12.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.
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.
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".
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.
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.

**Import test data**

If you want some test data in your vagrant Friendica instance import the database dump friendica_test_data.sql like so (inside the VM):

		$> mysql -u root -p friendica < /vagrant/friendica_test_data.sql

You will then have the following accounts to login:

  * admin, password admin
  * friendica1, password friendica
  * 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/).
Added more explanation to developing with Vagrant 2015-01-14 17:32:10 +00:00			`Vagrant for Friendica Developers`
			`===================`

			`* [Home](help)`

Documented the Vagrant test data. 2015-02-02 22:14:01 +00:00			`Getting started`

Added more explanation to developing with Vagrant 2015-01-14 17:32:10 +00:00			`[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:`

			`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.`
			`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".`
			`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.`
			`8. Commit and push your changes directly back to Github.`
added info how to halt the VM to the vagrant docs. 2015-01-16 10:20:48 +00:00
			`If you want to stop vagrant after finishing your work, run the following command`

			`$> vagrant halt`

			`in the development directory.`

Documented the Vagrant test data. 2015-02-02 22:14:01 +00:00			`Import test data`

			`If you want some test data in your vagrant Friendica instance import the database dump friendica_test_data.sql like so (inside the VM):`

			`$> mysql -u root -p friendica < /vagrant/friendica_test_data.sql`

			`You will then have the following accounts to login:`

			`* admin, password admin`
			`* friendica1, password friendica`
			`* 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.`

added info how to halt the VM to the vagrant docs. 2015-01-16 10:20:48 +00:00			`For further documentation of vagrant, please see [the vagrantdocs](https://docs.vagrantup.com/v2/).`