Prerequisite:
- Equella Server
- Open Equella Administration console
|
User 1 |
User 2 |
username |
userfirst |
usersecond |
equellausername |
userequella |
|
randomfield |
1 |
|
Open Equella server
MDL-33981 has intructions for equella setup as well
You will need to have an Equella server accessible
If you don't have one, here is an example of how to setup an Equella server:
You can follow the guidelines from
https://openequella.github.io/gettingstarted/InstallingEquella.html
https://openequella.github.io/guides/InstallationAdminGuide.html
OR
if any tools are missing or not anymore supported, you can run this command:
apt update && apt install -y openjdk-8-jdk imagemagick gstreamer1.0-libav wget unzip ffmpeg
|
After installing imagemagick, you might need to run this command :
ln -s /usr/bin/ffmpeg /usr/bin/avconv
|
Once you have the requirement to install equella server, you can run these commands:
wget https://github.com/openequella/openEQUELLA/releases/download/2022.1.0/equella-installer-2022.1.0.zip \
|
&& unzip equella-installer-2022.1.0.zip \
|
&& ln -s /usr/bin/ffmpeg /usr/bin/avconv
|
cd equella-installer-2022.1.0 \
|
&& java -jar enterprise-install.jar
|
# set up the server following the instruction
#navigate to the openEQUELLA install directory, then the manager folder (e.g. path-to-equella/manager)
./manager start
|
./equellaserver start
|
access to your server by appending to the URL "/institutions.do?method=admin"
download and import the institution
https://github.com/openequella/openequella.github.io/blob/master/guides/6.4VanillaReferenceInstitution.tgz
Open Equella Administration console
Download the admin console package
https://github.com/openequella/openEQUELLA-admin-console-package/releases
You can follow the guideline from
https://github.com/openequella/openequella.github.io/blob/master/guides/AdministrationConsole/openEQUELLA2019.1-AdministrationConsolePackageGuide.md
The Launcher enables the configuration of openEQUELLA servers and the launching of their respective Administration Consoles, as well as various other functions.
To open the Launcher:
cd admin-console-package-for-linux-v1.1.0/
|
./Linux-launcher.sh
|
set up the connection to the server.
Get the shared secret to add it to your moodle site
add users with specific username
Testing instruction:
-
- Start without any custom profile field
- Got to reporitory settings -> manage repositories
- Enable EQUELLA repository
- Go to EQUELLA repository settings
- Create a repository instance
- The new setting is EQUELLA userfield.
=> Notice the new field only display "Username"
- Create a custom profile field of type short text, name it (ex: equellausername )
- Add another custom profile field of a different type (to test that it won't be displayed in the settings)
- Get a test user (user1) and fill up these custom profile fields and a test user 2 without data for these custom user fields
- Go to reporitory settings -> manage repositories
- Enable EQUELLA repository
- Go to EQUELLA repository settings
- Create a repository instance
- Fill the require field
- The new setting is EQUELLA userfield.
- You should see the list of the different field. In our test you will see username and equellausername
- Select one of them
- Hit the save button
- Go to the Open Equella Administration server configuration (see Open Equella Administration configuration below these instructions)
- In openEquella Administration server, update a user's username with the matching username or equellausername you have chosen previously. This will be used to allow the connection between moodle and the equella server.
- Back to moodle
- Logout and Login to update the configuration setting
- Go to any course
- Add an activity or resource of type file/folder
- In the content area, click on the file icon to add a file
- Select the Equella repository
- Verify you have access
- Update the username field and/or the username required in the openEquella administration:
- Go to EQUELLA repository settings
- Select the previously used repository instance
- Change the EQUELLA userfield to another one that doesn't exist in the equella server
AND/OR
- Go to your Equella server administration
- Update the user's username you previously gave access to with a non matching username.
- Refresh you browser / session to make sure the connection between moodle and Equella server have been reinitialised
- Go back to any activity / resource of type file/folder
- In the content area, click on the file icon to add a file
- Select the Equella repository
- Verify you don't have access