Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme and beginners docs to de-CLAW #116

Merged
merged 3 commits into from
Jun 23, 2019
Merged

Update readme and beginners docs to de-CLAW #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54420e7
Update README.md
manez Jun 19, 2019
488f91b
Update forBeginners.md
manez Jun 19, 2019
7162a70
Update README.md
manez Jun 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# CLAW Vagrant Playbook
# Islandora 8 Vagrant Playbook
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](./LICENSE)

## Introduction

This is an Ansible playbook for Islandora CLAW. It also has a vagrant file to bring up a development
environment virtual machine for Islandora CLAW.
This is an Ansible playbook for Islandora 8. It also has a vagrant file to bring up a development
environment virtual machine for Islandora 8.

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

If you struggle with following the instructions for setting up the requirements a simpler step-by-step guidelines for turning nearly any computer into an Islandora CLAW environment can be found at "[for Beginners](forBeginners.md)".
If you struggle with following the instructions for setting up the requirements a simpler step-by-step guidelines for turning nearly any computer into an Islandora 8 environment can be found at "[for Beginners](forBeginners.md)".

## Requirements

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

### JWT

CLAW uses JWT for authentication across the stack. Crayfish microservices, Fedora, and Drupal all use them.
Islandora 8 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 master token of `islandora` to make testing easier. To use it, just set
the following header in HTTP requests:

Expand All @@ -167,14 +167,14 @@ You can access the FITS Web Service at http://localhost:8080/fits/

### Matomo

CLAW Playbook installs an instance of the [Matomo](https://matomo.org/) (formally PIWIK) web analytics platform. You can access your instance at: http://localhost:8000/matomo
Islandora 8 Playbook installs an instance of the [Matomo](https://matomo.org/) (formally PIWIK) web analytics platform. You can access your instance at: http://localhost:8000/matomo

* username: admin
* password: islandora

## Roadmap

1. Get feature parity with [CLAW Vagrant](https://github.com/Islandora-CLAW/claw_vagrant)
1. Get feature parity with [Islandora 8 Vagrant](https://github.com/Islandora-CLAW/claw_vagrant)
2. Break each role out into its own git repo, so they can be listed on galaxy
3. Test install on multiple boxes
4. Test with other operating systems (?)
Expand Down
10 changes: 5 additions & 5 deletions forBeginners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CLAW Sandbox Creation for Beginners
# Islandora 8 Sandbox Creation for Beginners

This document will explain, in the simplest step-by-step possible, how to take a computer from "unwanted box in the corner with no operating system" to working Islandora CLAW sandbox.
This document will explain, in the simplest step-by-step possible, how to take a computer from "unwanted box in the corner with no operating system" to working Islandora 8 sandbox.

## Terminology:
Some terminology you may need to understand to follow this step-by-step document:
Expand Down Expand Up @@ -37,7 +37,7 @@ You will also need an empty USB drive with at least 2 GB of space and a computer

* If you're not sure how much RAM and free memory on your hard drive is on the computer and you have a Windows computer, you can follow this [tutorial](https://www.computerhope.com/issues/ch000149.htm) to check that it meets the requirements.

* If you don't have an operating system on the machine you want to use for your sandbox, you can try to install the Ubuntu operating system as described in step 2 and 3, then follow the instructions in this [tutorial](https://howtoubuntu.org/how-to-find-out-how-much-ram-is-installed-in-ubuntu) to make sure you have more than 3 GB of RAM (called Memory in the tutorial) and 4GB of hard drive memory (called Disk in the tutorial) required to run the default version of Islandora CLAW.
* If you don't have an operating system on the machine you want to use for your sandbox, you can try to install the Ubuntu operating system as described in step 2 and 3, then follow the instructions in this [tutorial](https://howtoubuntu.org/how-to-find-out-how-much-ram-is-installed-in-ubuntu) to make sure you have more than 3 GB of RAM (called Memory in the tutorial) and 4GB of hard drive memory (called Disk in the tutorial) required to run the default version of Islandora 8.

#### Step two: Create a bootable drive of Ubuntu

Expand Down Expand Up @@ -85,8 +85,8 @@ Open the terminal of your new Ubuntu computer to download the remaining requirem

>$ sudo apt-get install ansible

#### Step five: Clone and Run Islandora CLAW vagrant
1. To download Islandora CLAW, type the following into the terminal:
#### Step five: Clone and Run Islandora 8 vagrant
1. To download Islandora 8, type the following into the terminal:

>$ git clone https://github.com/Islandora-Devops/claw-playbook.git

Expand Down