.. 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. .. 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: Site information; Site statistics single: Enhanced site statistics .. _site_statistics: Site statistics ~~~~~~~~~~~~~~~~~~ *Administration → Admin home → Site statistics* You can view a number of statistics about your Mahara site that give you an indication of how your site is used: * Overall site information * Overview information about users * Quick information about groups * Basic statistics about pages available on the site * Content statistics for the current week * Historical data for content statistics since the beginning of collecting these statistics * Quick overview of institutions and some of their basic statistics .. seealso:: All site administrators **and site staff** have access to the statistics. They can also view the :ref:`statistics individually for each institution `. Full site information ^^^^^^^^^^^^^^^^^^^^^^^^^^^ The full site information gives you information about a number of important things that site administrators may wish to see in an overview quickly. .. figure:: /images/administration/site_statistics_overview.* :alt: Overview of the site Overview of the site #. **Weekly site data**: Growth of the number of users, pages and groups displayed in a graph. #. **Site installed**: Installation date of your site. #. **Users**: Number of * registered users, i.e. everybody who has an account * active users, i.e. users that have at least logged in once and have done something #. **Groups**: Number of groups and average group membership of a user #. **Pages**: Number of pages and average pages per user with pages #. **Database size**: Size of your database on the server #. **Disk usage**: The amount of disk space your Mahara installation uses #. **Mahara version**: Version number of Mahara and the latest stable release #. **Cron**: Information on whether cron is running or not. If it says "Cron is not running", please check it. It may be running partially. .. index:: single: Download daily user statistics on the site level Users ^^^^^^^^^^^ On the *Users* tab of the site statistics, you see some overview statistics about the users on the site. .. figure:: /images/administration/site_statistics_users.* :alt: Statistics about users Statistics about users You can see the following: #. **Daily user statistics**: The statistics show information about how many users logged in, were created and existed in total on a specific day. #. **Your average user**: Some basic statistics about your typical user such as: * average number of friends with the name of the person with most friends; * average number of pages with the author of the most pages; * average amount of file quota used with the user who has used most. #. A graph displays the number of members based on institutions. #. **Export statistics in CSV format**: Download the daily user statistics in a CSV file. .. index:: single: Download group statistics on the site level Groups ^^^^^^^^^^^^^ On the *Groups* tab of the site statistics, some information is available about groups. .. figure:: /images/administration/site_statistics_groups.* :alt: Statistics about groups Statistics about groups You can see the following: #. **Biggest groups**: The groups are listed in descending order according to the number of their members including * number of members * number of pages * number of forums * number of forum posts #. The number of groups by group type: * Course group * Standard group #. The number of groups by access type: * Open membership * Approved membership * Controlled membership #. A graph shows the groups according to group and access type. #. **Export statistics in CSV format**: Download the cumulative statistics about the groups in a CSV file. .. index:: single: Download basic page statistics on the site level Pages ^^^^^^^^^^ The *Pages* tab in the site statistics provides you with basic information about pages that have been created on the site. .. figure:: /images/administration/site_statistics_pages.* :alt: Statistics about pages Statistics about pages You can see the following: #. **Most popular pages**: The most popular pages are sorted in descending order with links to the pages and the owner. #. **Most frequently used blocks in portfolio pages**: Statistics of the top blocks used in pages. #. A graph shows the distribution of profile, group and portfolio pages. #. **Export statistics in CSV format**: Download the cumulative statistics about the pages and number of views as well as comments in a CSV file. .. index:: single: Weekly statistics about content on the site level Content ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The *Content* tab in the site statistics holds information about * artefacts * general site information .. figure:: /images/administration/site_statistics_content.* :alt: Statistics for the current week for all artefacts etc. Statistics for the current week for all artefacts etc. #. **Name**: The statistics item itself, e.g. artefact or other general item on site level. It is linked to the *Historial data* statistics for an overview of the changes over time. #. **Modified**: This column shows the number of updates during the current week. #. **Total**: This column shows the total number of instances of the items. #. **Export statistics in CSV format**: Download the cumulative statistics about all the statistics shown for the week in a CSV file. .. seealso:: If you wish to see the number of different blocks used in portfolios, please go to the :ref:`institution statistics `. .. note:: The number of total content statistics will vary because only when an artefact or block was used will the statistics be created for that type. .. index:: single: Historical statistics about content on the site level Historical data ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The *Historical data* tab in the site statistics holds historical data over time about a particular content item that you have clicked on in the *Content* tab. Changes are saved per default on a weekly basis. However, whenever you run the cron manually, a new statistics will be created as well. You can also download the statistics as CSV file. .. figure:: /images/administration/site_statistics_historical_data.* :alt: Historical data for individual content items Historical data for individual content items #. **Historical statistics for field**: Display of the artefact or other item that you are looking at. #. **Date**: Display of the date when the statistics were created. #. **Modified**: Display of the number of modifications from the previous date to the next one when the statistics were created. #. **Total**: Total number of instances of this statistical item at the time the statistics were run. #. **Export statistics in CSV format**: Download the cumulative statistics for this particular item in a CSV file. .. note:: When you click on the *Historical data* tab without choosing an item to look at in particular beforehand, the number of users are displayed per default. .. index:: single: Institution statistics on the site level Institutions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The *Institutions* tab in the site statistics holds cumulative data on basic institution statistics. The numbers reflect the amount of content institution members have created. You find the totals for: * members * pages * blocks * artefacts * forum posts You can sort each column in the table by clicking on its heading and also download the statistics in a CSV file. When you click a number, you will be taken to the *Historical data* statistics page for that item in the respective institution. .. figure:: /images/administration/site_statistics_institutions.* :alt: Basic institution statistics Basic institution statistics .. note:: If your site allows users to be in more than one institution, their content will be counted twice as they are regarded as members in each institution. However, if looked at just the full site statistics where institutions do not play a role, there their content is only counted once. .. index:: single: Site statistics; Active institutions Logins ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The statistics about active institutions gives insight into how many members logged into Mahara during a particular time period and how many times logins were performed during that time period. .. figure:: /images/administration/site_statistics_logins.* :alt: Statistics about active institutions on the site Statistics about active institutions on the site #. Reporting time period. The default setting is the previous calendar month. .. note:: To alter the time period of the results you can add a **start** and an **end** option to the URL, e.g. ``admin/statistics.php?type=logins&start=2015-01-01&end=2015-04-30``. This will return the results for the 4-month period of 1 January to 30 April 2015. #. **Institution**: List of the institutions that are on the site. #. Click the arrow to change the sort order of a column. #. **Logins**: The number of logins during the time period for each individual institution. #. **Active users**: The number of distinct users from the institution that used the site at any point during the reporting time period. #. The number of institutions on the site. #. These statistics can be downloaded as CSV file. .. note:: All institutions are always included in the export no matter whether they are all shown on the screen or not. .. index:: pair: Administration; Clear caches single: Site administrator; Clear caches single: New in Mahara 16.10; Clear caches .. _clear_caches: |new in Mahara 16.10| 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