Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-79959

Add custom field picker for SSO identification in repository_equella

XMLWordPrintable

    • MOODLE_401_STABLE, MOODLE_403_STABLE
    • MOODLE_404_STABLE
    • MDL-79959-repo-equella-sso-identification
    • Easy
    • Hide

      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:

        1. Start without any custom profile field
        2. Got to reporitory settings -> manage repositories
        3. Enable EQUELLA repository
        4. Go to EQUELLA repository  settings
        5. Create a repository instance
        6. The new setting is EQUELLA userfield.
          => Notice the new field only display "Username"
        7. Create a custom profile field of type short text, name it (ex: equellausername )
        8. Add another custom profile field of a different type (to test that it won't be displayed in the settings)
        9. Get a test user (user1) and fill up these custom profile fields and a test user 2 without data for these custom user fields
        10. Go to reporitory settings -> manage repositories
        11. Enable EQUELLA repository
        12. Go to EQUELLA repository  settings
        13. Create a repository instance
        14. Fill the require field
        15. The new setting is EQUELLA userfield.
        16. You should see the list of the different field. In our test you will see username and equellausername
        17. Select one of them 
        18. Hit the save button
        19. Go to the Open Equella Administration server configuration (see Open Equella Administration configuration below these instructions)
        20. 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.
        21. Back to moodle
        22. Logout and Login to update the configuration setting
        23. Go to any course
        24. Add an activity or resource of type file/folder 
        25. In the content area, click on the file icon to add a file
        26. Select the Equella repository
        27. Verify you have access
        28. Update the username field and/or the username required in the openEquella administration:
          1. Go to EQUELLA repository  settings
          2. Select the previously used repository instance
          3. Change the EQUELLA userfield to another one that doesn't exist in the equella server
            AND/OR 
          4. Go to your Equella server administration
          5. Update the user's username you previously gave access to with a non matching username.
        29. Refresh you browser / session to make sure the connection between moodle and Equella server have been reinitialised
        30. Go back to any activity / resource of type file/folder
        31. In the content area, click on the file icon to add a file
        32. Select the Equella repository
        33. Verify you don't have access
      Show
      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

      The purpose is to add the option to choose from different custom profile field, which one will be used for authentication with Repository_Equella instead of the default value Username

      In repository Equella, a new setting can be added as a drop down list. This list will be filled with the username as default and the list of custom user field. The field that will be selected will be used as username to get the SSO token.

            guillaumeb87 Guillaume BARAT
            guillaumeb87 Guillaume BARAT
            Nathan Nguyen Nathan Nguyen
            Ilya Tregubov Ilya Tregubov
            Kim Jared Lucas Kim Jared Lucas
            Votes:
            1 Vote for this issue
            Watchers:
            19 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 1 day, 4 hours, 51 minutes
                1d 4h 51m

                  Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.