Skip to content

Commit

Permalink
Document deprecation of the islandora/8 box. (#203)
Browse files Browse the repository at this point in the history
  • Loading branch information
rosiel authored Oct 13, 2021
1 parent 6ebe1ca commit d7870f4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 14 deletions.
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,17 @@

## Introduction

This is an Ansible playbook for Islandora 8. It also has a vagrant file to bring up a release or development virtual machine for Islandora 8. For an alternative installation using Docker, please see [ISLE](https://islandora.github.io/documentation/installation/docker-compose/).
This is an Ansible playbook for provisioning an instance of Islandora. This repository includes a Vagrantfile, so `vagrant up` will create a local virtual machine and run the playbook on it. For an alternative installation using Docker, please see [ISLE](https://islandora.github.io/documentation/installation/docker-compose/).

This virtual machine **should not** be used in production **yet**.

## Variables

### Base box

By default, Vagrant creates a complete Islandora 8 1.1.0 instance. This version is the current offical release of Islandora.

If you want to build a VM that pulls in the latest Islandora code (suitable for a development environment, for example), before running `vagrant up`, open `Vagrantfile` and change the `$vagrantBox` variable to 'ubuntu/focal64':

```
# Available boxes are 'islandora/8' and 'ubuntu/focal64'
# Use 'ubuntu/focal64' to build a dev environment from scratch.
# Use 'islandora/8' if you just want to download a ready to run VM.
$vagrantBox = ENV.fetch("ISLANDORA_DISTRO", "islandora/8")
```
By default the Vagrantfile builds Islandora on a `ubuntu/focal64` base box.

The [Islandora 8 base box](https://app.vagrantup.com/islandora/boxes/8) is now deprecated.

### System Resources

Expand All @@ -34,7 +26,7 @@ export ISLANDORA_VAGRANT_MEMORY=5040

## Use

Detailed installation and usage instructions can be found on the [official installation documentation for Islandora 8](https://islandora.github.io/documentation/installation/playbook/).
Detailed installation and usage instructions can be found on the [official installation documentation for Islandora](https://islandora.github.io/documentation/installation/playbook/).

## Connect

Expand Down Expand Up @@ -88,7 +80,7 @@ You can access the IIIF interface at: http://localhost:8080/cantaloupe/iiif/2/

### JWT

Islandora 8 uses JWT for authentication across the stack. Crayfish microservices, Fedora, and Drupal all use them.
Islandora uses JWT for authentication across the stack. Crayfish microservices, Fedora, and Drupal all use them.
Crayfish and Fedora have been set up to use a default token of `islandora` to make testing easier. To use it, just set
the following header in HTTP requests:

Expand Down
3 changes: 2 additions & 1 deletion Vagrantfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ $virtualBoxDescription = ENV.fetch("ISLANDORA_VAGRANT_VIRTUALBOXDESCRIPTION", "I

# Available boxes are 'islandora/8' and 'ubuntu/focal64'
# Use 'ubuntu/focal64' to build a dev environment from scratch.
# Use 'islandora/8' if you just want to download a ready to run VM.
# Use 'islandora/8' if you just want to download a ready to run VM that is version 1.1.0 of Islandora
# The 'islandora/8' box is no longer mantained.
$vagrantBox = ENV.fetch("ISLANDORA_DISTRO", "ubuntu/focal64")

# vagrant is the main user
Expand Down

0 comments on commit d7870f4

Please sign in to comment.