This is an old revision of the document!
Vagrant for Friendica Developers
Getting started
Vagrant is a virtualization solution for developers. No need to setup up a webserver, database etc. before actually starting. Vagrant creates a virtual machine for you that you can just run inside VirtualBox and start to work directly on Friendica.
It brings an Ubuntu Xenial (16.04) with PHP 7.0 and MySQL 5.7.16
What you need to do
Prepare
- Install VirtualBox and vagrant. Please use an up-to-date vagrant version from https://www.vagrantup.com/downloads.html
- Git clone your Friendica repository. Inside, you'll find a “Vagrantfile” and some scripts in the utils folder
Run Vagrant
- Run
vagrant up
from inside the friendica clone:$> vagrant up
. Be patient: When it runs for the first time, it downloads an Ubuntu Server image - Run
vagrant ssh
to log into the virtual machine to log in to the VM:$> vagrant ssh
- Open your test installation in a browser. Go to
192.168.22.10
. The mysql database is calledfriendica
, the mysql user and password both arefriendica
Developing Friendica
- Work on Friendicas code in your git clone on your machine (not in the VM). Your local working directory is set up as a shared directory with the VM (/vagrant)
- Check the changes in your browser in the VM. Debug via the “vagrant ssh” login. Find the Friendica log file /vagrant/logfile.out
- Commit and push your changes directly back to Github
Stopping Vagrant
- If you want to stop vagrant after finishing your work, run the following command
$> vagrant halt
in the development directory. This will not delete the virtual machine. - To ultimately delete the virtual machine run
$> vagrant destroy
and$> rm /vagrant/config/local.config.php
to make sure that you can start from scratch with another “vagrant up”.
Accounts and Passwords
The vagrant Friendica instance contains a test database. You will then have the following accounts to login:
- user:
admin
, password:admin
- user:
friendica1
, passwordfriendica1
- user:
friendica2
, passwordfriendica2
and so on untilfriendica5
friendica1
is connected to all othersfriendica1
has two groups:group1
withfriendica2
andfriendica4
,group2
withfriendica3
andfriendica5
friendica2
andfriendica3
are connectedfriendica4
andfriendica5
are connected
For further documentation of vagrant, please see the vagrant*docs*.