Demo ISLE Installation

Expectations: It takes an average of 45 minutes to read this documentation and complete this installation.

This Demo ISLE Installation creates an Islandora environment on your personal computer that you can view locally in your browser as https://isle.localdomain. This process includes an un-themed Drupal website and an empty Fedora repository so you may ingest test objects, add or edit metadata, update fields in SOLR indexing, develop code, and otherwise "kick the tires" on ISLE.

Please post questions to the public Islandora ISLE Google group, or subscribe to receive emails. The Glossary defines terms used in this documentation.

Assumptions / Prerequisites

  • This Demo ISLE Installation is intended for a personal computer.

  • You will be using ISLE version 1.2.0 or higher.

  • You are using Docker-compose 1.24.0 or higher.

  • You have already git cloned the ISLE Project to your personal computer.

  • For Microsoft Windows:

    • You have installed Git for Windows and will use its provided "Git Bash" as your command line interface; this behaves similarly to LINUX and UNIX environments.

Step 1: Edit "/etc/hosts" File

Enable the Demo ISLE Installation to be viewed locally on a personal computer browser as: https://isle.localdomain.


Step 2: Clone ISLE Repository

Note: The location you select to clone the ISLE repository becomes your project directory. We recommend using the default user home directory. (You may choose a different location, but it must not be a protected folder such as system or root directory.)

  • Open a terminal (Windows: open Git Bash)
  • Enter the following to change to the user's home directory:
    • cd ~
  • Clone the repository:
    • git clone https://github.com/Islandora-Collaboration-Group/ISLE.git
  • Change to the directory containing ISLE:
    • cd ISLE
  • Enter the following command to display the present working directory (full path) of your ISLE project.
    • pwd
  • Please note the location of your ISLE project (from above command) as you will use that location path in subsequent steps.

    • Example output (Mac): "/Users/localmacaccount/ISLE"
    • Example output (Windows): "/c/Users/somebody/ISLE"
  • For Microsoft Windows:

    • Please follow the steps below to edit the "demo.env" file:
    • Press the Windows key.
    • Type Notepad
    • In the search results, RIGHT-CLICK Notepad, select Run as administrator, and enter Yes to prompt.
    • Select File -> Open
    • At top of dialog window, navigate to your ISLE project (refer to the output of the "pwd" command).
    • At right side of dialog window, use the dropdown menu to change Text Documents (*.txt) to All Files (*.*)
    • Select the file: demo.env
      • Click Open
    • Find the following line:
      • # COMPOSE_CONVERT_WINDOWS_PATHS=1
    • In the above line, delete the first two characters (#) so as to uncomment the line. It should now look like this:
      • COMPOSE_CONVERT_WINDOWS_PATHS=1
    • Click File > Save, and then File -> Exit.

Step 3: Download the ISLE Images

Using the same open terminal:

  • Navigate to your ISLE project directory. (You may already be in this directory.)

  • Copy the sample.env to .env. By default, the Demo environment is setup. The .env is no longer tracked by git. (ISLE versions =< 1.4.2)

  • cp sample.env .env

  • Download all of the latest ISLE Docker images (~6 GB of data may take 5-10 minutes):

  • docker-compose pull

Step 4: Launch Process

Using the same open terminal:

  • Run the docker containers:

    • docker-compose up -d
    • Note: the " -d" argument stands for "detached" meaning the command will persist even if you close your terminal or your computer sleeps etc…)
  • Please wait a few moments for the stack to fully come up. Approximately 3-5 minutes.

Using the same open terminal:

  • View only the running containers: docker ps
  • View all containers (both those running and stopped): docker ps -a
  • All containers prefixed with isle- are expected to have a STATUS of Up (for x time).
  • If any of these are not UP, then use Demo ISLE Installation: Troubleshooting to solve before continuing below.

Step 5: Run Islandora Drupal Site Install Script

This process may take 10-20 minutes (depending on system and internet speeds)

  • Run the install site script on the Apache container by copying and pasting the appropriate command:
    • For Mac/Ubuntu/CentOS/etc: docker exec -it isle-apache-ld bash -c "cd /utility-scripts/isle_drupal_build_tools && ./isle_islandora_installer.sh"
    • For Microsoft Windows: winpty docker exec -it isle-apache-ld bash -c "cd /utility-scripts/isle_drupal_build_tools && ./isle_islandora_installer.sh"
For Microsoft Windows:
You may be prompted by Windows to:
- Share the C drive with Docker. Click Okay or Allow.
- Enter your username and password. Do this.
- Allow vpnkit.exe to communicate with the network. Click Okay or Allow (accept default selection).
- If the process seems to halt, check the taskbar for background windows.
  • You should see a lot of green [ok] messages.
  • If the script appears to pause or prompt for y/n, DO NOT enter any values; the script will automatically answer for you.
  • Proceed only after this message appears: "Done. 'all' cache was cleared."

Step 6: Test the Site

  • In your web browser, enter this URL: https://isle.localdomain
  • Note: You may see an SSL error warning that the site is unsafe. It is safe, it simply uses "self-signed" SSL certs. Ignore the error and proceed to the site.
  • Log in to the local Islandora site:
    • Username: isle
    • Password: isle

Step 7: Ingest Sample Objects

The Islandora Collaboration Group provides a set of Islandora Sample Objects with corresponding metadata for testing Islandora's ingest process. These sample objects are organized by solution pack and are zipped for faster bulk ingestion.

  • To download these sample objects, clone them to your computer's desktop:
git clone https://github.com/Islandora-Collaboration-Group/islandora-sample-objects.git
  • Follow these ingestion instructions How to Add an Item to a Digital Collection
  • (Note: Getting Started with Islandora contains explanations about content models, collections, and datastreams.)
  • After ingesting content, you will need to add an Islandora Simple Search block to the Drupal structure. (The default search box will only search Drupal content, not Islandora content.)
    • Select from the menu: Structure > Blocks > Islandora Simple Search
    • Select: Sidebar Second
    • Click: Save Blocks at bottom of page
    • You may now search for ingested objects that have been indexed by SOLR

Next Steps

Once you are ready, you may progress to either:


Additional Resources


End of Demo ISLE Installation