doc/Vagrant.md

   1 Vagrant for Friendica Developers
   2 ===================
   3
   4 * [Home](help)
   5
   6 Getting started
   7 ---------------
   8
   9 [Vagrant](https://www.vagrantup.com/) is a virtualization solution for developers.
  10 No need to setup up a webserver, database etc. before actually starting.
  11 Vagrant creates a virtual machine for you that you can just run inside VirtualBox and start to work directly on Friendica.
  12
  13 It brings an Ubuntu Xenial (16.04) with PHP 7.0 and MySQL 5.7.16
  14
  15 What you need to do:
  16
  17 1. Install VirtualBox and vagrant.
  18 Please use an up-to-date vagrant version from https://www.vagrantup.com/downloads.html.
  19 2. Git clone your Friendica repository.
  20 Inside, you'll find a "Vagrantfile" and some scripts in the utils folder.
  21 3. Run "vagrant up" from inside the friendica clone:
  22         $> vagrant up
  23 Be patient: When it runs for the first time, it downloads an Ubuntu Server image.
  24 4. Run "vagrant ssh" to log into the virtual machine to log in to the VM:
  25         $> vagrant ssh
  26 5. Open you test installation in a browser.
  27 Go to 192.168.22.10.
  28 The mysql database is called "friendica", the mysql user and password both are "friendica".
  29 6. Work on Friendica's code in your git clone on your machine (not in the VM).
  30 Your local working directory is set up as a shared directory with the VM (/vagrant).
  31 7. Check the changes in your browser in the VM.
  32 Debug via the "vagrant ssh" login.
  33 Find the Friendica log file /vagrant/logfile.out.
  34 8. Commit and push your changes directly back to Github.
  35
  36 If you want to stop vagrant after finishing your work, run the following command
  37
  38                 $> vagrant halt
  39
  40 in the development directory.
  41 This will not delete the virtual machine.
  42 9. To ultimately delete the virtual machine run
  43
  44         $> vagrant destroy
  45         $> rm /vagrant/config/local.config.php
  46
  47 to make sure that you can start from scratch with another "vagrant up".
  48
  49 The vagrant Friendica instance contains a test database.
  50 You will then have the following accounts to login:
  51
  52   * admin, password admin
  53   * friendica1, password friendica1
  54   * friendica2, password friendica2 and so on until friendica5
  55   * friendica1 is connected to all others. friendica1 has two groups: group1 with friendica2 and friendica4, group2 with friendica3 and friendica5.
  56   * friendica2 and friendica3 are connected. friendica4 and friendica5 are connected.
  57
  58 For further documentation of vagrant, please see [the vagrant*docs*](https://docs.vagrantup.com/v2/).