Installing Reveal Web
Installing on Windows (XP/Vista/7)
Windows installations are done using the installer kit.
Installing Reveal Web on Ubuntu/Linux
Even though these instructions describe a typical Ubuntu 11.10 install any Linux variant supporting a LAMP stack should do.
Installed Linux system or VM. (Most testing and these instructions use Ubuntu)
Access to root operations using sudo.
Network connection higher speed the better.
Install Reveal Web Software
The latest can be downloaded via any browser from http://sourceforge.net/projects/revealweb/ just select the green download image. or From the command line.
sudo wget -P ~/Downloads http://sourceforge.net/projects/revealweb/files/V1.0/revealdesktop-V1.0.zip/download
sudo unzip ~/Downloads/revealdesktop-V1.0.zip -d /var
Great now we can continue.
Install Using Reveal Setup Tool
This is a simple script that will perform all the command line tasks for you. For our purposes we are using the password reveal but feel free to substitute whatever is right for your site.
Use th arrows and space bar to select LAMP and Phpmyadmin. The following screen should appear.
Select Ok you should see the package install text scroll on the screen.
The installs will start you will be presented with several screens we will go over them now.
The mysql configuration screen should appear enter your mysql root password reveal in this case.
Next the apache2 configuration screen should appear.
Use <space> to select apache2 then <tab> to select Ok then <enter> to continue.
The phpmyadmin configuration screen should appear next. Since we already configured a database use <tab> to select No and hit hit enter.
You should now see the text Install complete at the bottom of the screen.
We are done with this phase.
Creating the Reveal Web Database
The first step will be to install out database schema we will use phpmyadmin for this.
Open a browser to http://localhost/phpmyadmin/ and you should see the screen below.
Enter Username root and Password reveal or whatever you have been using and hit the Go button.
Now we will create a database to use we will call it revealdesktop.
As with the password the database name is configurable and we will show how to do that in a bit.
Select the Databases tab on the top menu and enter your database name select the Create button.
You should have your database name appear in the left column select it.
Creating Reveal User
Select the revealdesktop database you have just created and hit the Privileges tab.
Now select Add a new User
Enter Reveal in the User name field.
Enter REVEAL in the Password field and again in the Re-type field.
Importing Revel Web Tables
Now select the top Import tab the import screen will appear.
Enter /var/www/db/revealdesktop_1.0.1.sql or use the 'Browse' button to traverse to the db directory and select the schema.
Hit Go and a list of tables should show in the left column and a green success banner should appear.
We are done and can use the system now.
Edit Reveal Configuration
Now we can tell the reveal database to use whatever MySQL password and database name we chose previously.
sudo gedit /var/www/server/os-config.php
Scroll down to the database configuration section. And make the following changes.
Select the Save button.
As you can see there is a clear text password in this file and should not be publicly visible.
I'll explain later on methods for securing important files and directories.
Logging on to Reveal
Open http://localhost from a browser window.
Let following window will appear. Login with Usermame director Password demo and select Login to get started.
The screen below should appear.
If so the great we are done with the install.
Post Installation Tasks
Our first order of business is to secure our data and set up some permissions.
If you would prefer not to use sudo when modifying the Reveal code do the following. I'm assuming you are user reveal here.
sudo chown -R reveal.reveal /var/www
Since the apache web server typically run's as www-data and needs read access to the MySQL password let's lock down the os-config.php as follows.
sudo chmod 660 /var/www/server/os-config.php sudo chgrp www-data /var/www/server/os-config.php
Finally data files (images/documents/models/...) need to be written to the /uploads directory and needs to be writable by the web server so.
sudo chmod 775 /var/www/uploads sudo chgrp www-data /var/www/uploads
Loading the Demo
The Reveal web demo consists of two sections.
Schema - Table definitions and data which we import as we did the empty reveal schema in section import.
Images - These are a set of predefined images coinciding with the demo schema. It is a zip file which we will unzip into uploads.
Download the images. (note: sudo won't be needed if you changed ownership to yourself previously)
open a web browser to http://sourceforge.net/projects/revealweb/files/V1.0/demo-images-V1.0.zip and save the zipfile or wget -P ~/Downloads http://sourceforge.net/projects/revealweb/files/V1.0/demo-images-V1.0.zip
cd /var/www sudo unzip ~/Downloads/demo-images-V1.0.zip
Load table schema as we did in Importing Revel Web Tables. This time select revealdesktop_1.0.1_demo.sql and import.
You should see the following message note the filename in parentheses.
Running the Demo
Log into reveal as director as we did in section Logging on to Reveal.
Double click the 'Data Entry' in the upper left hand corner. (You might want to stretch your window to to avoid bunching up of forms)
Click on Artifacts => Pot => Attachments and you should see the following screen.
Good, this means that your demo configuration worked you can now poke arount with the demo.
Creating First Demo Artifact
From our Pot artifact page above let's create a new artifact. Select 'New Record'
Now enter some data
Select Save and you should see the following popup appear.
The reason for this is this artifact is not associated with a parent. In this case a Locus.
Go to the Locus tab and select one.
Now choose Save and the following popup should appear.
Good, now you can use the Uploads tab to associate images/documents or whatever to the kermit artifact.
The uploads supports multiple file browsing and drag and drop for html5 browsers.
Sentinal - The PHP daemon that handles job requests from Reveal Web and generated 3D models from 2D images.
Reveal Analyze - The Windows based front end analysis tool for data entered with Reveal Web.
Reveal web site at LEMS Lab in Brown University.
Sentinal is a PHP daemon that polls for jobs submitted by the Reveal Web system.
The software can be installed using the ubuntu_setup tool we initially used to install Revel web.
The complete install instructions and software can be found on the Sentinal web site.
Click on the following image to upload a new version of the PNG logo image for your project: