Skip to content

README.md

Latest commit

 

History

History
133 lines (94 loc) · 3.85 KB

README.md

File metadata and controls

133 lines (94 loc) · 3.85 KB

Introduction

The is a development environment virtual machine for the Islandora and Fedora 4 project. It should work on any operating system that supports VirtualBox and Vagrant.

N.B. This virtual machine should not be used in production.

Requirements

  1. VirtualBox
  2. Vagrant
  3. git

Variables

System Resources

By default the virtual machine that is built uses 2GB of RAM. Your host machine will need to be able to support the additional memory use. You can override the CPU and RAM allocation by creating ISLANDORA_VAGRANT_CPUS and ISLANDORA_VAGRANT_MEMORY environment variables and setting the values. For example, on an Ubuntu host you could add to ~/.bashrc:

export ISLANDORA_VAGRANT_CPUS=4
export ISLANDORA_VAGRANT_MEMORY=4096

Hostname and Description

If you use a DNS or host file management plugin with Vagrant, you may want to set a specific hostname for the virtual machine. You can do that with the ISLANDORA_VAGRANT_HOSTNAME variable. The ISLANDORA_VAGRANT_VIRTUALBOXDESCRIPTION variables can be used to track the VM build. For example:

export ISLANDORA_VAGRANT_HOSTNAME="islandora-deux"
export ISLANDORA_VAGRANT_VIRTUALBOXDESCRIPTION="Islandora CLAW"

Use

VirtualBox:

  1. git clone https://github.com/Islandora-CLAW/CLAW
  2. cd CLAW/install
  3. vagrant up

DigitalOcean:

  1. git clone https://github.com/Islandora-CLAW/CLAW
  2. cd CLAW/install
  3. vagrant plugin install vagrant-digitalocean
  4. Set the following environment variables:
  • DIGITALOCEAN_TOKEN -- Your DigitalOcean API token
  • DIGITALOCEAN_KEYNAME -- Your DigitalOcean ssh key name
  • DIGITALOCEAN_KEYPATH -- Path to your ssh keys that you've setup with DigitalOcean
  1. vagrant up --provider=digital_ocean

Amazon:

  1. git clone https://github.com/Islandora-CLAW/CLAW
  2. cd CLAW/install
  3. vagrant plugin install vagrant-aws
  4. Set the following environment variables:
  • AWS_KEY
  • AWS_SECRET
  • AWS_KEYNAME
  • AWS_KEYPATH
  1. vagrant up --provider=aws

N.B. You may not be able to connect to your AWS instance depending on VPC settings.

Connect

You can connect to the machine via the browser at http://localhost:8000.

The default Drupal login details are:

  • username: admin
  • password: islandora

MySQL:

  • username: root
  • password: islandora

The Fedora 4 REST API can be accessed at http://localhost:8080/fcrepo/rest. It currently has authentication disabled.

Tomcat Manager:

  • username: islandora
  • password: islandora

You can connect to the machine via ssh: ssh -p 2222 vagrant@localhost

The default VM login details are:

  • username: vagrant
  • password: vagrant

Environment

  • Ubuntu 14.04.4
  • Drupal 8.1.3
  • MySQL 5.5.49
  • Apache 2.24.7
  • Tomcat 7.0.52
  • Solr 4.10.3
  • Camel 2.14.1
  • Fedora 4.5.1
  • Fedora Camel Component 4.2.0
  • BlazeGraph 1.5.1
  • Karaf 4.0.5
  • Sync 0.0.0
  • Islandora 7.x-2.x
  • PHP 5.6.22 and 7.0.7
  • Java 8 (Oracle)

Windows Troubleshooting

If you receive errors involving \r (end of line) you have two options:

  1. Clone down the current development branch using --single-branch.
git clone --single-branch --branch sprint-002 git@github.com:Islandora-CLAW/CLAW.git <optional directory name>

A benifit to this approach is that files created or edited on a Windows environment will be pushed back to your fork with appropriate LF endings.

  1. Modify your global .gitconfig file to disable the Windows behavior of autocrlf entirely.

Edit the global .gitconfig file, find the line:

autocrlf = true

and change it to

autocrlf = false

Remove and clone again. This will prevent Windows git clients from automatically replacing Unix line endings LF with Windows line endings CRLF.