From 1c5c3b55b701016ed67eb51fdc9274aa667377d2 Mon Sep 17 00:00:00 2001 From: mrblippy Date: Fri, 4 Jan 2019 14:44:16 +1100 Subject: [PATCH 1/4] #28 Updated getting started guide to be less developer focussed --- gettingstarted/InstallingEquella.md | 69 ++++++++++++++++------------- 1 file changed, 39 insertions(+), 30 deletions(-) diff --git a/gettingstarted/InstallingEquella.md b/gettingstarted/InstallingEquella.md index cc41f8d..125006b 100644 --- a/gettingstarted/InstallingEquella.md +++ b/gettingstarted/InstallingEquella.md @@ -3,39 +3,46 @@ # 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/equella/Equella#download-required-software) guide. +The following dependencies are required to successfully install openEQUELLA. -- Java 8 (Oracle) -- ImageMagick -- Libav -- Database +- [Java 8 JDK](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) -Needed if you are building your own install binary: -- GIT -- SBT +- [ImageMagick](https://www.imagemagick.org/script/download.php) -## Build the Installer +- [LibAV](https://libav.org/download/) (**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/equella/Equella). +- Database Server -## Install openEQUELLA -1. Unzip the openEQUELLA install zip binary. -1. Run the GUI installer: +- - PostgreSQL + - Microsoft SQL + - Oracle + + + +## 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/``` -### Windows Install -Using the equellaserver and manager bat scripts, configure and install as Windows services. ## Starting openEQUELLA -The primary log to watch is located under ```{install_location}/logs/resource-centre/{current_date}/application.{X.}html``` + +### Windows + +1. In the windows command prompt, navigate to **/manager** +2. To register openEQUELLA as a windows service type **equellaserver install** +3. To start the openEQUELLA service type **equellaserver start** ### \*nix ```bash @@ -44,24 +51,26 @@ The primary log to watch is located under ```{install_location}/logs/resource-ce 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 ) -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. -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. +## Accessing openEQUELLA / Finish Setup +Once openEQUELLA has started you can log into the server admin pages using the hostname and port you configured in the installer. + +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/equella/equella.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. From 46fe7663105b4aab4000ff4423c2be57139e63f3 Mon Sep 17 00:00:00 2001 From: mrblippy Date: Fri, 4 Jan 2019 15:20:10 +1100 Subject: [PATCH 2/4] #21 update moodle integration links --- guides/MoodleIntegrationGuide.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/guides/MoodleIntegrationGuide.md b/guides/MoodleIntegrationGuide.md index a647bb5..d55a991 100644 --- a/guides/MoodleIntegrationGuide.md +++ b/guides/MoodleIntegrationGuide.md @@ -51,7 +51,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 This section describes the required configuration changes to openEQUELLA to support a seamless integration. To achieve this, an openEQUELLA LTI Consumer needs to be registered, along with a Shared Secret configuration. @@ -125,16 +125,11 @@ The next step in the integration process is to download the openEQUELLA Moodle M This section describes the required configuration changes to Moodle to support the integration. openEQUELLA provides a module that allows Moodle users to easily contribute, search and select openEQUELLA items, and link them to a course. ### Download and install the openEQUELLA Moodle Modules -The Moodle Modules are available from the Downloads page in the openEQUELLA Github repository - -To download the Moodle Modules -1. Navigate to the [Downloads Page](../IntegrationsDownloads.md) in the openEQUELLA Github Repository - -The openEQUELLA Moodle components are made up of three zip files. Each zip contains files relevant to specific sections of the Moodle site. +Download the **openEQUELLA Moodle Module** [here](https://github.com/equella/moodle-mod_equella/archive/master.zip). This module allows users to add openEQUELLA content as resources or activities zip are the files for the standard module functionality to integrate Moodle with openEQUELLA (referred to in this guide as the openEQUELLA Resource module). -Inside the Module to add openEQUELLA content as resources or activities zip are the files for the standard module functionality to integrate Moodle with openEQUELLA (referred to in this guide as the openEQUELLA Resource module). +Download the **openEQUELLA Search Block** [here](https://github.com/equella/moodle-block_equella_search.git). This block allows users to search openEQUELLA directly. -Inside the Block for users to search openEQUELLA directly and Block for users to view their openEQUELLA tasks and notifications zips are the files to add portlets to the Moodle front and course pages, allowing direct openEQUELLA access (openEQUELLA Blocks). +Download the **openEQUELLA Tasks Block** [here](https://github.com/equella/moodle-block_equella_tasks/archive/master.zip). This block users to view their openEQUELLA tasks and notifications zips are the files to add portlets to the Moodle front and course pages For complete installation the contents of each zip file need to be extracted to the corresponding folder in the Moodle filesystem. From 5b126e3495688ab7986274996e776f4cb4841d96 Mon Sep 17 00:00:00 2001 From: mrblippy Date: Wed, 9 Jan 2019 11:12:34 +1100 Subject: [PATCH 3/4] #21 doing a spot of rewording --- gettingstarted/InstallingEquella.md | 2 +- guides/MoodleIntegrationGuide.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/gettingstarted/InstallingEquella.md b/gettingstarted/InstallingEquella.md index 125006b..3d9c97c 100644 --- a/gettingstarted/InstallingEquella.md +++ b/gettingstarted/InstallingEquella.md @@ -14,7 +14,7 @@ The following dependencies are required to successfully install openEQUELLA. - Database Server -- - PostgreSQL + - PostgreSQL - Microsoft SQL - Oracle diff --git a/guides/MoodleIntegrationGuide.md b/guides/MoodleIntegrationGuide.md index d55a991..3c570f7 100644 --- a/guides/MoodleIntegrationGuide.md +++ b/guides/MoodleIntegrationGuide.md @@ -125,11 +125,11 @@ The next step in the integration process is to download the openEQUELLA Moodle M This section describes the required configuration changes to Moodle to support the integration. openEQUELLA provides a module that allows Moodle users to easily contribute, search and select openEQUELLA items, and link them to a course. ### Download and install the openEQUELLA Moodle Modules -Download the **openEQUELLA Moodle Module** [here](https://github.com/equella/moodle-mod_equella/archive/master.zip). This module allows users to add openEQUELLA content as resources or activities zip are the files for the standard module functionality to integrate Moodle with openEQUELLA (referred to in this guide as the openEQUELLA Resource module). +Download the **openEQUELLA Moodle Module** [here](https://github.com/equella/moodle-mod_equella/archive/master.zip). This module allows users to add openEQUELLA content as resources or activities (referred to in this guide as the openEQUELLA Resource module). Download the **openEQUELLA Search Block** [here](https://github.com/equella/moodle-block_equella_search.git). This block allows users to search openEQUELLA directly. -Download the **openEQUELLA Tasks Block** [here](https://github.com/equella/moodle-block_equella_tasks/archive/master.zip). This block users to view their openEQUELLA tasks and notifications zips are the files to add portlets to the Moodle front and course pages +Download the **openEQUELLA Tasks Block** [here](https://github.com/equella/moodle-block_equella_tasks/archive/master.zip). This block enables users to view their openEQUELLA tasks and notifications. This can be added as portlets to the Moodle front and course pages. For complete installation the contents of each zip file need to be extracted to the corresponding folder in the Moodle filesystem. From 31c6e85654a80631817df24b5396de62b2f25556 Mon Sep 17 00:00:00 2001 From: mrblippy Date: Thu, 10 Jan 2019 16:40:53 +1100 Subject: [PATCH 4/4] #28 add some supported versions for dependencies --- gettingstarted/InstallingEquella.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/gettingstarted/InstallingEquella.md b/gettingstarted/InstallingEquella.md index 3d9c97c..4fab893 100644 --- a/gettingstarted/InstallingEquella.md +++ b/gettingstarted/InstallingEquella.md @@ -5,18 +5,19 @@ ## Environment setup The following dependencies are required to successfully install openEQUELLA. -- [Java 8 JDK](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) +- [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) +- [ImageMagick](https://www.imagemagick.org/script/download.php) (Tested with ImageMagick 6.9.8 Q8) -- [LibAV](https://libav.org/download/) (**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.) +- [LibAV](https://libav.org/download/) (tested with 11.7) + + (**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.) - Database Server - - PostgreSQL - - Microsoft SQL - - Oracle + - PostgreSQL (8 or higher) + - Microsoft SQL (2008 or higher) + - Oracle (11g or higher) @@ -55,7 +56,7 @@ To stop openEQUELLA, run the same command to start the application, but pass in **Note:** The primary log to watch is located under: -{install_location}/logs/resource-centre/{current_date}/application.{X.}html +`{install_location}/logs/resource-centre/{current_date}/application.{X.}html` @@ -74,3 +75,7 @@ At this point, openEQUELLA is 'running', but still needs an institution to be us 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). \ No newline at end of file