Read Me

PROCEDURE D'INSTALLATION DU SITE VOLAUVENT

	l'installation requiert les outils suivants :
		-ant
		-mysql client et serveur
		-serveur Tomcat
		-svn (pour récupérer les sources depuis un dépôt subversion)

1/ Récupérer les sources
	
		si vous ne disposez pas des fichiers sources dans une archive, vous pouvez les récupérez
	à partir du dépôt subversion de sourceforge.
	
		Dans un terminal :
		
			- créer un dossier volauvent : 
					$ mkdir volauvent
			
			- copier les sources ou les importer depuis sourceforge :
					$ svn checkout svn://svn.code.sf.net/p/volauvent/code volauvent-code
					
2/ Création de la base de données

		Se connecter à mysql et créer la base de données 'volauvent'.
		Créer un nom d'utilisateur 'voluser' et son mot de passe 'volpass'.
		
		Dans un terminal :
			
			-se connecter à mysql :
				$ mysql -u root -p
				
				> GRANT ALL PRIVILEGES ON volauvent.* TO 'voluser'@'%' IDENTIFIED BY 'volpass';
	
				> FLUSH PRIVILEGES;
	
				> QUIT;	
				
3/ Déploiement de la base de données

		A la racine du projet, déployer la base de données via ant.
		
			Dans un terminal :
				$ ant fill_database
			
			le mot de passe pour se connecter à mysql est requis.
			


/!\ En cas d'erreurs avec ant, ne pas oublier de nettoyer les fichiers générés avec ant.
			Dans un terminal :
				$ ant clean

4/ Déploiement du projet sous Tomcat

		A la racine du projet, déployer les fichiers compilés et le contenu web archivés 
	dans un fichier .war sous tomcat.
		Il faut préalablement avoir démarré tomcat.
	
		Dans un terminal :
			$ sudo /opt/apache-tomcat-{version}/bin/startup.sh
			
			$ ant deploy
			
		Si un problème est rencontré lors de l'exportation sous tomcat, il y a la possibilité
	d'exporter manuellement l'archive .war sous tomcat :
			-ouvrir un navigateur web
			
			-aller à l'adresse localhost:8080/manager/html
			
			-entrer les identifiant et mot de passe (par défaut "tomcat" et "tomcat"
			sinon aller voir dans le fichier /opt/apache-tomcat-6.0.33/conf/tomcat-users.xml)
			
			- aller voir à déployer->fichier WAR à déployer -> parcourir
			
			-sélectionner le fichier WAR généré, il se trouve dans {dossier racine}/ant_build
			
			-cliquer sur déployer
			
4 bis / Générer le fichier WAR du projet

		Le fichier WAR est généré automatiquement lors du déploiement sous tomcat, mais on peut 
	aussi le générer indépendamment.
	
			Dans un terminal :
				$ ant make_war
			
		Le fichier généré se trouve dans le dossier ant_build
		
5/ Générer la javadoc

		Générer la javadoc du code java du projet dans des fichiers html qui se trouvent dans le 
	dossier doc.
	
			Dans un terminal :
				$ ant javadoc
				

6/ Sauvegarder la base de données

			Sauvegarder la base de données dans un fichier .sql.
			
			Dans un terminal :
				$ ant dump_database
				
			le fichier {nom du projet}.sql se trouve dans le dossier 'database'

7/ Supprimer le site

		Supprimer le site du serveur tomcat, et les sources de l'ordinateur.
		
			Dans un terminal :
				$ ant undeploy
				
				$ rm -rf *

		Autre méthode pour supprimer le site sur le serveur tomcat :
			- se connecter à la page http://localhost:8080/manager/html
			
			- dans Applications, aller à l'onglet du projet désiré
			
			- cliquer sur 'Retirer'