Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
documentation [2018/01/26 19:34]
colin [Prerequisites]
documentation [2019/06/28 18:12] (current)
webadmin [Prerequisites]
Line 8: Line 8:
 Wildbook is a cloud-based software application for collaboratively storing and analyzing data about animals in a study population. Its ultimate goal is to make it easy for a wildlife project to quickly go from data collection to analysis and generation of new knowledge. Wildbook allows you to collaborate better and to save time managing data sets. Wildbook is a cloud-based software application for collaboratively storing and analyzing data about animals in a study population. Its ultimate goal is to make it easy for a wildlife project to quickly go from data collection to analysis and generation of new knowledge. Wildbook allows you to collaborate better and to save time managing data sets.
  
-A single software instance of Wildbook application is deployed into a web server (we use [[https://​aws.amazon.com|Amazon Web Services]] ​Ubuntu servers) and can host one or multiple distinct mark-recapture studies. We will call this distinct instance of the application for a particular study a "​Wildbook instance"​.+A single software instance of Wildbook application is deployed into a web server (we use Microsoft Azure Ubuntu servers) and can host one or multiple distinct mark-recapture studies. We will call this distinct instance of the application for a particular study a "​Wildbook instance"​.
  
 <​html>​ <​html>​
Line 34: Line 34:
  
 ====MediaAsset==== ====MediaAsset====
-A **MediaAsset** represents a media object (photo or video) captured in a wildlife study. The corresponding data construct within Wildbook is org.ecocean.media.MediaAsset. A MediaAsset is stored in a MediaAssetStore object. A MediaAssetStore may be a local file system or a remote service, such as Amazon S3.+A **MediaAsset** represents a media object (photo or video) captured in a wildlife study. The corresponding data construct within Wildbook is org.ecocean.media.MediaAsset. A MediaAsset is stored in a MediaAssetStore object. A MediaAssetStore may be a local file system or a remote service.
  
 {{::​wildbookimageexample.png?​200|}} {{::​wildbookimageexample.png?​200|}}
Line 179: Line 179:
  
     * **[[http://​www.oracle.com/​technetwork/​java/​index.html|Java SE 8]]** (a.k.a, "Java 1.8"). This are available from [[http://​www.oracle.com/​technetwork/​java/​index.html|Oracle]] or [[http://​openjdk.java.net/​projects/​jdk8/​|OpenJDK]]. At a minimum, download and install the Java Runtime Environment (JRE); if you wish to develop Java programs, download and install the Java Development Kit (JDK), which includes the JRE. Don't forget to define JAVA_HOME as a system environment variable (settings its value to the file system path to Java on your computer) to allow Java-based applications to use your installed Java version.     * **[[http://​www.oracle.com/​technetwork/​java/​index.html|Java SE 8]]** (a.k.a, "Java 1.8"). This are available from [[http://​www.oracle.com/​technetwork/​java/​index.html|Oracle]] or [[http://​openjdk.java.net/​projects/​jdk8/​|OpenJDK]]. At a minimum, download and install the Java Runtime Environment (JRE); if you wish to develop Java programs, download and install the Java Development Kit (JDK), which includes the JRE. Don't forget to define JAVA_HOME as a system environment variable (settings its value to the file system path to Java on your computer) to allow Java-based applications to use your installed Java version.
-    * **Tomcat Webserver, version ​or greater**, ​ which is available from the [[http://​tomcat.apache.org/​download-70.cgi|Apache Software Foundation]]. Download the "​binary distribution"​ that is appropriate for your operating system (e.g., "​64-bit Windows zip" for 64-bit Windows machines, or "​zip"​ or "​tar.gz"​ for Linux and Macintosh machines). Tomcat is a "​servlet container"​ that can run Java-based applications under a web server. It can also act as a web server by itself. Jetty, older versions of  Tomcat, and other J2EE containers/​servers may work but have not been tested. Integration of Tomcat with third party web servers (e.g., Apache 2.2.x) is common, but this topic is well beyond the scope of these instructions. These sample instructions assume that Tomcat has been installed on your local laptop or desktop and is listening on port 8080.+    * **Tomcat Webserver, version ​or greater**, ​ which is available from the [[http://​tomcat.apache.org/​download-70.cgi|Apache Software Foundation]]. Download the "​binary distribution"​ that is appropriate for your operating system (e.g., "​64-bit Windows zip" for 64-bit Windows machines, or "​zip"​ or "​tar.gz"​ for Linux and Macintosh machines). Tomcat is a "​servlet container"​ that can run Java-based applications under a web server. It can also act as a web server by itself. Jetty, older versions of  Tomcat, and other J2EE containers/​servers may work but have not been tested. Integration of Tomcat with third party web servers (e.g., Apache 2.2.x) is common, but this topic is well beyond the scope of these instructions. These sample instructions assume that Tomcat has been installed on your local laptop or desktop and is listening on port 8080.
  
     * [[http://​www.imagemagick.org/​script/​convert.php|ImageMagick]] - ImageMagick must be available from the command line for image manipulation. Specifically,​ we use the '​convert'​ command for image thumbnail generation but may use other commands in the future.     * [[http://​www.imagemagick.org/​script/​convert.php|ImageMagick]] - ImageMagick must be available from the command line for image manipulation. Specifically,​ we use the '​convert'​ command for image thumbnail generation but may use other commands in the future.
Line 185: Line 185:
     * sendmail - Wildbook can email data contributors and researchers with data updates. On Linux servers, sendmail is required.     * sendmail - Wildbook can email data contributors and researchers with data updates. On Linux servers, sendmail is required.
  
-Technically,​ Wildbook can also be run on Windows and Mac laptops and desktops, but we highly recommend running Wildbook on an Ubuntu Linux virtual machine from [[https://​aws.amazon.com|Amazon Web Services]], which makes the server setup and management process very easy. If you need support, please contact [[mailto:​services@wildbook.org|services@wildme.org]]. Be aware that we are happy to answer questions but cannot offer comprehensive instructions on Mac or Windows installation.+Technically,​ Wildbook can also be run on Windows and Mac laptops and desktops, but we highly recommend running Wildbook on an Ubuntu Linux virtual machine from Azure, which makes the server setup and management process very easy. If you need support, please contact [[mailto:​services@wildbook.org|services@wildme.org]]. Be aware that we are happy to answer questions but cannot offer comprehensive instructions on Mac or Windows installation.
 ==== Installing Tomcat ==== ==== Installing Tomcat ====
  
 Installing Tomcat is beyond the scope of this document, but it is very well documented on the web.  Installing Tomcat is beyond the scope of this document, but it is very well documented on the web. 
  
-**//We HIGHLY recommend running Wildbook on an Ubuntu Linux web server through ​[[https://​aws.amazon.com/​ec2/​|Amazon Web Services' ​EC2 service]].//**+**//We HIGHLY recommend running Wildbook on an Ubuntu Linux web server through ​Microsoft's Azure cloud//**.
  
   * Tomcat is very well supported for Linux, but instructions for downloading and installing will vary according to Linux flavor. Consult your Linux distro (you may already have Tomcat) or the Web for Tomcat installation instructions for your Linux platform.   * Tomcat is very well supported for Linux, but instructions for downloading and installing will vary according to Linux flavor. Consult your Linux distro (you may already have Tomcat) or the Web for Tomcat installation instructions for your Linux platform.
Line 197: Line 197:
  
  
-//NOTE: Since somewhere around version 7.0.30+ (approximately),​ Tomcat includes a tomcat7-websockets.jar file that must be removed before Tomcat will load with Wildbook. 
-// 
  
 ===Known good configurations=== ===Known good configurations===
  
-We run Wildbook exclusively on Ubuntu servers on [[https://​aws.amazon.com|Amazon Web Services]] (generally an m4.large EC2 instance). We use Java 8 and Tomcat ​7/8. +We run Wildbook exclusively on Ubuntu servers on Microsoft'​s Azure cloud. We use Java 8and Tomcat 8. 
  
 ==== Deploying the WAR file ==== ==== Deploying the WAR file ====