Skip to content

Installation

Irene Vagionakis edited this page Feb 4, 2022 · 39 revisions
  1. Check that you have Java 7 or 8 and a Java Development Kit (JDK) on your machine (e.g. following both 'Option 1' and 'Option 2' procedures that are explained here, including the final step related to javac). If not, download and install the JDK from http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html.
  2. Get the EFES software: either download the ZIP from https://github.com/EpiDoc/EFES/archive/master.zip or clone from Github if you have an account already.
  3. If you downloaded the ZIP file, unzip it in a directory of your choosing (e.g. on your Desktop), changing the folder name from 'EFES-master' into 'EFES'.
  4. Open up your Command prompt/Terminal.
  5. Start the EFES build process:
    1. Windows:

      1. in the search box in the Start menu type: cmd
      2. navigate to your EFES folder like so: cd Desktop\EFES
      3. type the command: build.bat

    2. GNU/Linux or Mac OS X:

      1. in the search box type: terminal
      2. navigate to your EFES folder like so: cd Desktop/EFES
      3. run the command: sh build.sh


        This script will start Jetty, a lightweight web server that is pre-configured to run all of the EFES components.
  6. In your file navigator navigate to /webapps/ROOT/content/xml/epidoc/. This is where you will put your EpiDoc XML files. When you first install EFES, this folder will contain 15 example EpiDoc files to help you start off.


  7. Visit http://127.0.0.1:9999/ with your web browser. You’ll see a “Welcome to EFES” page.
  8. Congratulations! EFES is now all set up. You can start filling in your content.

Remember to keep Jetty running on your Terminal/Command Line while working on EFES.