-----------------------------------------------------------
README FOR VIRTUAL APPLIANCE PHRASEANET VERSION 4 (preview)
-----------------------------------------------------------
------------
 ABOUT THIS
------------
I) About the VM
	This Virtual Machine (VM) is an OVA file format made with VirtualBox. 
	It is also compliant with Vmware fusion and Vmware workstations applications.

	For more information on VirtualBox: https://www.virtualbox.org/

	Don't use this VM in Production. It's not released for this purpose.

II) About Phraseanet
	Phraseanet V4 is currently in beta Stage. This version can contain bugs or be unstable. 
	Use this version ONLY for testing.

	More information about Phraseanet Administration on
	https://docs.phraseanet.com/3.8/en/Admin/index.html
	Contact Us ! info@alchemy.fr

--------------------
 Running Phraseanet
--------------------
I) Import the VM

	- VirtualBox:
		In the interface, go to File -> Import Appliance and select the vm file.
		For example : vm_ovf1_Phraseanet_4.x.x.ova

	- Vmware Fusion:
		Considering you get the OVA Virtual Machine file on your computer...
			- In VMWare Fusion, Select Import in File menu.
			- Select the OVA file on your computer and press Import.
			- If a prompt window reports an Importation failure, click on Retry.
			- After importation, launch the converted Phraseanet vmware vm virtual machine as you usually do in VMWare Fusion.

--------------
 TECHNICAL INFORMATIONS
--------------
I) How to access Phraseanet
		Start the VM and locate it's IP address.
		On Host, launch a web browser and type the IP address of the VM.
		ex : http://ip_address
		
II) Credentials
	- SSH
		login: root
		password: root

	- Phraseanet
		login: admin
		password: admin

	- MariaDB super user
		login: root
		password: root

	- MariaDB phraseanet user
		login: phraseanet
		password: phraseanet

III) Phraseanet
	Phraseanet is in /var/www/Phraseanet/
	This setup comes with all standard dependencies for video, photo and document subdefinitions generation.
	You have one Databox with a typical structure.
	This db has also a simple thesaurus.
	You can add your own databases with your own structure and thesaurus if you wish.

	At init this VM starts the Phraseanet scheduler for you with a sh script named phraseanetscheduler.sh.
	Another one also updates the Phraseanet configuration with the IP of the started VM (Phraseanetinitip.sh).
	All scripts are located in /etc/init.d/

	For all email exchanges (notifications, downloads by email, push and feedback, user registration), 
	please check the email setup from the Admin module --> setup --> email section
	Fill in the form with your email settings and credentials.

	You can also edit email section in the phraseanet config file in /var/www/Phraseanet/config/configuration.yml with user www-data 

		sudo -u www-data -s /bin/bash

	Compile phraseanet configuration after any change you do in this file with

		/var/www/Phraseanet/bin/console compile:configuration, with user www-data

	Change email of phraseanet admin user using "Forgotten password" function (on the homepage).

        SSL (https) is by default required for Oauth2 authentification via API. 
        This is not the case for this Virtual Machine Phraseanet installation.SSL requirement is disabled.
 
	You can reactivate https, in the Phraseanet config file.
 
                /var/www/Phraseanet/config/configuration.yml


                maintenance: false
                  languages: []
                  key: ''
                  api_require_ssl: true

        set api_require_ssl: to false
      
        Made modification with user www-data and compile your new configuration with cmd (in /var/www/Phraseanet/)
 
        bin/console compile:configuration  

             
 
IV)Upgrade Phraseanet

	To upgrade Phraseanet, execute the script "update-phraseanetV4.sh" in /var/www/Phraseanet/ with user www-data (su www-data -s /bin/bash).
This upgrade run a git fetch and checkout on branch 4.0 of https://github.com/alchemy-fr/Phraseanet and run a make for the installation of Phraseanet dependencies.
When we tag a new Phraseanet version (eg :4.0.0-beta.5 to 4.0.0-beta.6) , you need to run a command manually for Phraseanet datas to be updated.
This is to be done with user www-data in /var/www/phraseanet/ run bin/setup system:upgrade.
We offer no guaranty about this update procedure, backup your data before running script update.
The easier way to backup Phraseanet data, is to take a snapshot of your VM in your hyperviser.
If you execute update script or other operations with user "root", you need to change the owner of Phraseanet repository by running in console: 
chown www-data: -R /var/www/Phraseanet
The V4.0 Documentation are WIP at this time, so check https://docs.phraseanet.com.


Version : 1.1
Date : 20160507