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

Allow site summary to be set from install database CLI

    XMLWordPrintable

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 3.11
    • 3.11
    • Administration
    • MOODLE_311_STABLE
    • MOODLE_311_STABLE
    • MDL-70643-311
    • Hide

      Run each of the following against fresh Docker containers (or however you would normally install new sites)

      With help argument

      1. $ bin/moodle-docker-compose exec --user www-data webserver php admin/cli/install_database.php --help
        

      2. Confirm the following option is listed:

        --summary=STRING      The summary to be displayed on the front page
        

      With summary argument

      1. $ bin/moodle-docker-compose exec --user www-data webserver php admin/cli/install_database.php --agree-license --fullname="Docker" --shortname="Docker" --summary="Docker Site" --adminpass="admin" --adminemail="admin@example.com"
        

      2. Login as admin
      3. Navigate to Front page > Front page settings in site administration
      4. Confirm the Front page summary field contains "Docker Site"

      Without summary argument

      1. $ bin/moodle-docker-compose exec --user www-data webserver php admin/cli/install_database.php --agree-license --fullname="Docker" --shortname="Docker" --adminpass="admin" --adminemail="admin@example.com"
        

      2. Login as admin
      3. Navigate to Notifications in site administration
      4. Confirm you aren't prompted to set Front page summary as a new setting

      Invalid argument

      1. $ bin/moodle-docker-compose exec --user www-data webserver php admin/cli/install_database.php --agree-license --fullname="Docker" --shortname="Docker" --foo="bar" --adminpass="admin" --adminemail="admin@example.com"
        

      2. Confirm you see the following warning:

        Unrecognised options:
          --foo=bar
        

      Show
      Run each of the following against fresh Docker containers (or however you would normally install new sites) With help argument $ bin/moodle-docker-compose exec --user www-data webserver php admin/cli/install_database.php --help Confirm the following option is listed: --summary=STRING The summary to be displayed on the front page With summary argument $ bin/moodle-docker-compose exec --user www-data webserver php admin/cli/install_database.php --agree-license --fullname="Docker" --shortname="Docker" --summary="Docker Site" --adminpass="admin" --adminemail="admin@example.com" Login as admin Navigate to Front page > Front page settings in site administration Confirm the Front page summary field contains "Docker Site" Without summary argument $ bin/moodle-docker-compose exec --user www-data webserver php admin/cli/install_database.php --agree-license --fullname="Docker" --shortname="Docker" --adminpass="admin" --adminemail="admin@example.com" Login as admin Navigate to Notifications in site administration Confirm you aren't prompted to set Front page summary as a new setting Invalid argument $ bin/moodle-docker-compose exec --user www-data webserver php admin/cli/install_database.php --agree-license --fullname="Docker" --shortname="Docker" --foo="bar" --adminpass="admin" --adminemail="admin@example.com" Confirm you see the following warning: Unrecognised options: --foo=bar

    Description

      It's not possible to set the site summary when using the admin/cli/install_database.php CLI script (despite the script appearing to accept such an argument, because it doesn't warn about unrecognised arguments)

      Would be good if it would accept the --summary argument, as the admin/cli/install.php script does (MDL-49842)

      Would help with Docker installations, where this setting is usually missing, and prompted for on the upgrade settings page. See the discussion on https://github.com/moodlehq/moodle-docker/issues/121 for context

      Attachments

        1. 311_help.png
          311_help.png
          67 kB
        2. front_page_setting_with_summary.png
          front_page_setting_with_summary.png
          45 kB
        3. Frontpage_without_summary.png
          Frontpage_without_summary.png
          35 kB
        4. master_help_summary.png
          master_help_summary.png
          67 kB
        5. master_terminal_output.png
          master_terminal_output.png
          21 kB
        6. Screenshot from 2021-02-10 13-21-41.png
          Screenshot from 2021-02-10 13-21-41.png
          24 kB
        7. summary_frontpage.png
          summary_frontpage.png
          32 kB
        8. without_summary.png
          without_summary.png
          43 kB

        Issue Links

          Activity

            People

              pholden Paul Holden
              pholden Paul Holden
              David Matamoros David Matamoros
              Adrian Greeve Adrian Greeve
              Sujith Haridasan Sujith Haridasan
              Andrew Lyons, Huong Nguyen, Jun Pataleta, Michael Hawkins, Shamim Rezaie, Simey Lameze, Stevani Andolo
              Votes:
              2 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                17/May/21

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 2 hours, 15 minutes
                  2h 15m