.. include:: /shortcuts.rstext .. index:: pair: Administration; Navigation single: Site administrator; Administration overview Administration navigation -------------------------------- As site and institution administrator you have an additional navigation item, *Administration*. When you click on it, your navigation changes completely to give you quick access to the administration of Mahara. Depending on your role as site or institution administrator, you may see the full administration (site administrators) or only a subset of it (institution administrators). .. figure:: /images/administration/navigation_top_level_sa.* :alt: Top level navigation for site administrators Top level navigation for a **site administrator** once inside *Administration* .. figure:: /images/administration/navigation_top_level_ia.* :alt: Top level navigation for institution administrators Top level navigation for an **institution administrator** once inside *Administration* .. index:: pair: Administration; Admin home single: Site administrator; Admin home Admin home --------------- *Administration → Admin home* .. note:: *Admin home* is only accessible by site administrators. Overview ~~~~~~~~~~~~~~~~ You see all administrative items on the main page of the *Administration* on *Admin home*. .. figure:: /images/administration/admin_home_overview.* :alt: Administration overview page Administration overview page .. note:: Important warnings including their resolution are displayed in red so they cannot be overlooked easily. If a core Mahara plugin requires an upgrade, you will see a notice about it and only need to click the button *Run upgrade*. .. figure:: /images/administration/plugin_upgrade.* :alt: Upgrade notice for a plugin Upgrade notice for a plugin :index:`If a plugin needs to be installed `, click the *Install via extensions page* button to be taken to the *Plugin administration* for the installation. .. figure:: /images/administration/plugin_install_home.* :alt: Installation notice for a plugin Installation notice for a plugin .. index:: pair: Administration; Warnings single: Site administrator; Warnings single: Warning about small PHP session entropy length .. _admin_warnings: Warnings ~~~~~~~~~~~ After you have installed Mahara, you may see a number of warnings when you go to the *Administration* as site administrator. They should all be resolved to ensure that your site is secure and has all the necessary settings. .. figure:: /images/administration/admin_home_warning.* :alt: Example of a warning on the "Admin home" page Example of a warning on the *Admin home* page #. **Session entropy length**: Your PHP session.entropy_length setting is too small. Set it to at least 16 in your php.ini to ensure that generated session IDs are random and unpredictable enough. You can learn more about this advisory on the `OWASP session management cheatsheet `_. #. **Noreply email address**: If the system email address is empty or a malformed email address, you are asked to check and correct it in the :ref:`system mail address setting `. #. **Site-wide password salt**: If you do not have one set, please edit your :ref:`config.php file ` and set it to a reasonable length. #. **SAML setup**: If you do not have SAML authentication set up properly and do not have :ref:`SAML activated `, you do not see any warning messages as they would only go away if you activate the plugin and install all the required dependencies. .. index:: pair: Administration; Registration with the Mahara project single: Site administrator; Registration with the Mahara project .. _mahara_registration: Register your Mahara site ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ *Administration → Admin home → Register* As site administrator you can choose to register your Mahara site with `mahara.org `_ and help us compile a list of Mahara installations around the world to get a picture by how many people Mahara is used. Currently, this list is not published online. When you are on the administration overview page, you will see a link directly to the registration page. .. figure:: /images/administration/register.* :alt: Register your Mahara site Register your Mahara site You can preview the data that is sent. Sending weekly updates is recommended so that the information we have is up-to-date. **All information is sent anonymously.** We will only know, for example, which version of Mahara you are running, how many times blocks or artefacts have been used, how many users you have etc. .. figure:: /images/administration/register_site.* :alt: Register your Mahara site with the Mahara project Register your Mahara site with the Mahara project #. **Data that will be sent**: Click this panel to preview the data that will be sent from your site. #. **Send weekly updates**: Set this switch to "Yes" if you wish so send regular updates about your site to the project. These updates are based on changes in your site and include only anonymous updates. #. Click the *Register* button to finish your registration with the Mahara project or click *Cancel* to abort. .. index:: pair: Administration; Site information single: Site administrator; Site information Site information ~~~~~~~~~~~~~~~~~~~~ The *Site information* gives you as site administrator a quick overview of: * How your site is used. * When your site was installed. * How big the database is. * How much site data has been accumulated. * Which version of Mahara you are running. * Whether your cron is running or not. .. figure:: /images/administration/site_info.* :alt: Site information Site information If you have problems with your Mahara instance and you request information from the community `in the forums `_, this information, esp. about your version and the cron, are useful to have. Furthermore, the version number allows you to check that you have the latest security release of your Mahara version installed. .. index:: single: Cron errors are displayed in red .. seealso:: The cron job is very important in Mahara as a number of vital tasks are only performed when it is running. You can find more information of how to set it up `on the wiki `_. If the cron is not running or only partially running, that information is displayed in red. .. index:: pair: Administration; Clear caches single: Site administrator; Clear caches .. _clear_caches: Clear caches ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ *Administration → Admin home → Overview* A number of elements are cached in Mahara on the system level to speed up the site. In some cases, you may wish to force a new version though if the browser doesn't recognize it on its own. .. figure:: /images/administration/clear_caches.* :alt: Clear all caches at once Clear all caches at once Click the *Clear caches* button to clear all caches. .. note:: The caches can also be cleared via a commandline script, which system administrators can find in ``/admin/cli/clear_caches.php``. .. index:: pair: Administration; Maintenance mode single: Site administrator; Maintenance mode Close site ~~~~~~~~~~~~~ *Administration → Admin home → Overview* You may close the site to everyone except administrators. This is useful when you prepare for and complete a database upgrade. Only administrators will be able to log in until you either reopen the site or an upgrade is successfully completed. .. figure:: /images/administration/close_site.* :alt: Close your Mahara site Close your Mahara site