Skip to content

Commit 27fce05

Browse files
rtilla1whikloj
authored andcommitted
For Beginners document and reference in read me added (#74)
* Create forBeginners This is my attempt to use what I've learned to create a set of instructions that will bridge the gap between the current instructions and where some users (like myself) are at. * Edit formatting add tutorial link * Outline added * Finished First Draft * Corrected formatting * Update forBeginners.md * Corrections * Added spaces in step 4 for formatting * Added sudo to git install sudo/becoming administrator is necessary in order to make these changes to the computer * Update forBeginners.md * Include reference to "for beginners". * Additions to Glossary and Updates to Step 1
1 parent 95541f5 commit 27fce05

File tree

2 files changed

+102
-0
lines changed

2 files changed

+102
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ environment virtual machine for Islandora CLAW.
88

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

11+
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)".
12+
1113
## Requirements
1214

1315
1. [VirtualBox](https://www.virtualbox.org/)

forBeginners.md

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# CLAW Sandbox Creation for Beginners
2+
3+
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.
4+
5+
## Terminology:
6+
Some terminology you may need to understand to follow this step-by-step document:
7+
8+
Sandbox (n.) -- a copy of a software environment that you can "play in"; usually means a version that can be easily created,
9+
messed up, and wiped clean again
10+
11+
Terminal (n.) -- a command-line interface for your computer. This is the fancy/scary looking interface that sometimes has
12+
colorful text on a black background. Terminals provide more control than a GUI when making the kinds of advanced changes to
13+
a computer system that are required for software like the pre-requisite requirements for Islandora.
14+
15+
Requirement (n.) -- software/hardware basics that must be in place before a piece of software will run properly
16+
17+
GUI (n.) -- a graphical user interface. This is the "pretty" front end designed for end-users.
18+
19+
OS (n.) -- [Operating system](https://en.wikipedia.org/wiki/Operating_system) This is the software that supports a computer's basic functions. Examples of an OS include Microsoft Windows, macOS, and many flavors of Linux.
20+
21+
RAM (n.) -- Random Access Memory, also called memory, this is used for temporary storage.
22+
23+
Hard drive (n.) -- longer-term memory where computers store saved files and software.
24+
25+
### Step-by-step:
26+
#### Step one: Gather your equipment
27+
28+
Find the computer you want to use for your Islandora sandbox. It does not have to have an operating system (like Windows),
29+
but if it does, that's not a problem. It should be a machine that has been totally wiped or only has files that can be deleted. If you have any files on it that you would like to save, you should back them up elsewhere.
30+
31+
Other requirements this computer will (ideally) meet:
32+
1. 3GB of RAM (2GB of RAM required for Ubuntu desktop)
33+
2. 4GB of hard drive memory free (25 GB required for Ubuntu desktop)
34+
3. Internet connection
35+
36+
You will also need an empty USB drive with at least 2 GB of space and a computer with an existing OS and internet connection for step two.
37+
38+
* 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.
39+
40+
* 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.
41+
42+
#### Step two: Create a bootable drive of Ubuntu
43+
44+
On another computer, insert the USB drive. Follow [these instructions](https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-windows#0), or this summary:
45+
1. Download [Rufus](https://rufus.akeo.ie/).
46+
2. Download [Ubuntu desktop](https://www.ubuntu.com/download/desktop).
47+
3. Run Rufus and select Ubuntu boot selection and the correct USB drive.
48+
49+
#### Step three: Install Ubuntu as your new OS
50+
51+
On the Islandora sandbox computer, follow these [instructions](https://tutorials.ubuntu.com/tutorial/tutorial-install-ubuntu-desktop#0), or this summary:
52+
1. Insert USB drive into the computer.
53+
2. Restart the computer.
54+
3. If the welcome screen for Ubuntu doesn't pop up, restart again, this time holding down F12.
55+
4. On the welcome screen, select your language and "Install Ubuntu."
56+
4. Follow the Ubuntu prompts, supplying your information when requested, and otherwise accepting the default selections.
57+
1. For installation type, select "Erase [name of current operating system] and reinstall".
58+
1. Restart.
59+
1. Congratulations on your new Linux computer!
60+
61+
#### Step four: Download Requirements for Islandora
62+
63+
On your new Ubuntu computer, download the following:
64+
1. [Virtual Box](https://www.virtualbox.org/)
65+
2. [Vagrant](https://www.vagrantup.com/) (version 2.0 or required)
66+
67+
Open the terminal of your new Ubuntu computer to download the remaining requirements:
68+
1. To install [git](https://git-scm.com/) follow these [instructions](https://www.liquidweb.com/kb/install-git-ubuntu-16-04-lts/), or the following:
69+
70+
>$ apt-get update
71+
72+
>$ apt-get install git
73+
74+
>$ git --version
75+
76+
1. To install ansible, type the following lines of code, one at a time, into the terminal:
77+
78+
>$ sudo apt-get update
79+
80+
>$ sudo apt-get install software-properties-common
81+
82+
>$ sudo apt-add-repository ppa:ansible/ansible
83+
84+
>$ sudo apt-get update
85+
86+
>$ sudo apt-get install ansible
87+
88+
#### Step five: Clone and Run Islandora CLAW vagrant
89+
1. To download Islandora CLAW, type the following into the terminal:
90+
91+
>$ git clone https://github.com/Islandora-Devops/claw-playbook.git
92+
93+
2. When that script has finished running, open or move into the appropriate folder by typing the following into the terminal:
94+
95+
>$ cd claw-playbook
96+
97+
3. To run the scripts, type:
98+
99+
>$ vagrant up
100+

0 commit comments

Comments
 (0)