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

Jump to bottom

Install guide #39

Merged
merged 5 commits into from
Mar 30, 2020
Merged

Install guide #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c5c3b5
#28 Updated getting started guide to be less developer focussed
mrblippy Jan 4, 2019
46fe766
#21 update moodle integration links
mrblippy Jan 4, 2019
5b126e3
#21 doing a spot of rewording
mrblippy Jan 9, 2019
31c6e85
#28 add some supported versions for dependencies
mrblippy Jan 10, 2019
27a6deb
Merge branch 'master' into InstallGuide
edalex-ian Mar 30, 2020
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
63 changes: 33 additions & 30 deletions gettingstarted/InstallingEquella.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,65 +3,68 @@
# Installing openEQUELLA

## Environment setup
Assuming you are building and installing openEQUELLA in the same environment, the following should be setup. Details can be found in the [openEQUELLA Dev Setup](https://github.com/openequella/Equella#download-required-software) guide.

- Java 8 (Oracle)
- ImageMagick
- Libav
- Database
The following dependencies are required to successfully install openEQUELLA.

edalex-ian marked this conversation as resolved.
Show resolved Hide resolved
Needed if you are building your own install binary:
- GIT
- SBT
- [Java 8 JDK](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) (Latest version)
- [ImageMagick](https://www.imagemagick.org/script/download.php) (Tested with ImageMagick 6.9.8 Q8)
- [LibAV](https://libav.org/download/) (tested with 11.7)

edalex-ian marked this conversation as resolved.
Show resolved Hide resolved
## Build the Installer
(**Note:** This is not a compulsory step if video file attachments will not be used in your institution or you don’t require them to display in the Videos gallery view.)

If you don't have / don't want to use a pre-built binary, you can build openEQUELLA from source yourself by following the instructions on the main [openEQUELLA repo](https://github.com/openequella/Equella).
- Database Server

## Install openEQUELLA
1. Unzip the openEQUELLA install zip binary.
1. Run the GUI installer:
- PostgreSQL (8 or higher)
- Microsoft SQL (2008 or higher)
- Oracle (11g or higher)

## Installation

1. Download and unzip the openEQUELLA installer from [Github]( https://github.com/equella/Equella/releases)
1. Run installer:
```bash
~$ cd ~/equella-installer-{VERSION}
~$ java -jar enterprise-install.jar
```
You'll need to know where you've installed imagemagick, libav, java, and your database.
During the install process you will be asked to specify where you've installed imagemagick, libav, java, and your database. For Linux users run the following commands:

- Imagemagick in Ubuntu, run ```~$ whereis convert```.
- Libav in Ubuntu, run ```~$ whereis avconv```.

The 'Institution Administration URL' for local testing can be as simple as ```http://localhost:8080/admin/```
## Starting openEQUELLA

### Windows Install
Using the equellaserver and manager bat scripts, configure and install as Windows services.
### Windows

## Starting openEQUELLA
The primary log to watch is located under ```{install_location}/logs/resource-centre/{current_date}/application.{X.}html```
1. In the windows command prompt, navigate to **<install_location>/manager**
2. To register openEQUELLA as a windows service type **equellaserver install**
3. To start the openEQUELLA service type **equellaserver start**

### \*nix

```bash
~$ cd {install_location}/manager
~$ ./equellaserver start
and/or
~$ ./manager start
```
To stop openEQUELLA or the manager, run the same command to start the application, but pass in 'stop' instead of 'start'.
To stop openEQUELLA, run the same command to start the application, but pass in 'stop' instead of 'start'.

### Windows
Assuming openEQUELLA and the openEQUELLA Manager have been installed as services, navigate to your services, and select openEQUELLA to start.
**Note:** The primary log to watch is located under: `{install_location}/logs/resource-centre/{current_date}/application.{X.}html`

## Accessing openEQUELLA / Finish Setup
Use your browser to login to the openEQUELLA manager (default is <http://localhost:3000>)
From here you can click the "start" button to start the openEQUELLA app server if not already done from a Windows service or \*nix start script.

Once openEQUELLA has started you can log in to the server admin pages using the hostname and port you configured in the installer.
Once openEQUELLA has started you can log into the server admin pages using the hostname and port you configured in the installer.

edalex-ian marked this conversation as resolved.
Show resolved Hide resolved
The installation process will need to be completed in the server admin pages. Please access the server admin pages, configure the fields presented, and once presented with the database screen, initialize the database.
The installation process will need to be completed in the server admin pages. Please access the server admin pages, configure the fields presented, and once presented with the database screen, initialize the database.

At this point, openEQUELLA is 'running', but still needs an institution to be useful.

## Import an Institution
1. Download the [6.4 vanilla](https://github.com/openequella/openequella.github.io/blob/master/guides/6.4VanillaReferenceInstitution.tgz) institution.

1. Download the preconfigured [institution](https://github.com/equella/equella.github.io/blob/master/guides/6.4VanillaReferenceInstitution.tgz).
1. Using the server admin pages, import the institution
1. After the import completes, click 'Return to Institution Management'
1. Your newly imported institution should be enabled on the 'Institutions' page. Click 'Login' under 'Actions'
1. Login with the openEQUELLA super user ```TLE_ADMINISTRATOR```, and use the institution password you set when configuring the institution import.
1. After the import completes, click '**Return to Institution Management**'
1. Your newly imported institution should be enabled on the '**Institutions**' page. Click '**Login**' under '**Actions**'
1. Login with the openEQUELLA super user **TLE_ADMINISTRATOR**, and use the institution password you set when configuring the institution import.

For further information about openEQUELLA installation, please refer to the [Full Installation Guide](http://equella.github.io/guides/InstallationAdminGuide.html).
3 changes: 1 addition & 2 deletions guides/MoodleIntegrationGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ openEQUELLA Moodle integration can be broken into the following steps:
3. Install the openEQUELLA Moodle Module to the Moodle directory.
4. Activate the openEQUELLA Resource Module in Moodle.
5. Test the installation.


## Configure openEQUELLA

Expand Down Expand Up @@ -174,7 +174,6 @@ This section describes the required configuration changes to Moodle to support t

### Download and install the openEQUELLA Moodle Modules

The Moodle Modules are available from the Downloads page in the openEQUELLA Github repository
The Moodle Modules are available from each of their Github repositories:

* Moodle module - <https://github.com/openequella/moodle-mod_openEQUELLA>
Expand Down