.. include:: /shortcuts.rstext .. index:: pair: Site administration; Configure site .. _configure_site: Configure site ---------------- *Site administration → Configure site* In *Configure site* you can: * set general parameters for your Mahara site * edit site pages * determine the display of certain menu items * allow networking with Moodle * create and share pages * upload files .. index:: pair: Site administration; Site options .. _site_options: Site options ~~~~~~~~~~~~~~~~~~ *Site administration → Configure site → Site options* In *Site options* you can set some global options that will apply by default throughout the entire site. .. note:: One or more fields may be disabled if overridden by a setting in your config.php file. When you are done editing one or more settings, click the *Update site options* button at the bottom of the page. .. index:: pair: Site administration; Site settings single: New in Mahara 1.5; Drop-down site navigation .. _site_settings: Site settings ^^^^^^^^^^^^^^^^^^^ .. figure:: /images/site_admin/site_settings.* :alt: Site settings Site settings #. **Site name**: Choose a name for your Mahara instance. It appears in certain places around the site, e.g. in the title bar of the browser, and in emails sent from the site. Therefore, it should not be too long. #. **Language**: Set the default language for your site. If you have multiple language packs installed, you see a drop-down menu. Otherwise, the standard language, English, is displayed. #. **Country**: The country selected is the default for country selections throughout your Mahara installation, e.g. in :ref:`contact information `. #. **Theme**: Mahara comes with a number of themes that you can use. Choose one from the drop-down menu to make it the default theme for your site. If you have :ref:`institutions ` set up, they can choose their own theme. You can `search for community-contributed themes `_ on the Mahara wiki. #. |new15| **Drop-down navigation**: If selected, the main Mahara navigation uses a drop-down menu for its sub navigation. #. **Show homepage information**: If enabled, information about Mahara and how it is used is displayed on the homepage for logged-out and the *Dashboard* for logged-in users. Logged-in users can disable this. See also :ref:`Quick links `. #. **Send weekly updates?**: If checked, your site sends weekly updates to `mahara.org `_ with some statistics about your site. See also :ref:`Register your Mahara site `. .. note:: You can install more language packs. There is a `complete list of them `_ as well as `more information about the language packs `_ on the wiki. .. index:: Gravatar pair: Site administration; User settings single: New in Mahara 1.5; Logged-in profile page access single: New in Mahara 1.5; Staff report access .. _user_settings: User settings ^^^^^^^^^^^^^^^^^^ .. figure:: /images/site_admin/user_settings.* :alt: User settings User settings #. **Users can choose page themes**: If this setting is enabled, users can select a theme for their portfolio page. The page is displayed with this theme to other users. Thus, the institution or site theme can be overwritten. #. **Display remote avatars**: If checked, users' default profile pictures will be their `Gravatar `_ pictures (:ref:`remote avatar `). Users will need an account with Gravatar for this to work. #. **Users can hide real names**: If checked, users who have set a :ref:`display name ` may choose to be searchable only by their display name, and will not be found in searches by their real name. In the site administration section of the site, users are always searchable by their real names. An administrator (site and institution) always sees the display name, first and last name and username. #. **Search usernames**: If checked, usernames can be searched on as part of "Search users" on the :ref:`dashboard ` and via :ref:`Find friends `. #. **Anonymous comments**: If checked, logged-out users / users without a login can leave comments on public pages or pages they can access via a secret URL. #. |new15| **Logged-in profile access**: If this option is unchecked, profile pages are initially viewable by all logged-in users, but the owner is allowed to restrict access to a smaller group if they wish. Enable this option if you want to make sure all users can see each others' profile pages. Profiles of institution members will always be visible to other members of the same institution. #. |new15| **Staff report access**: If enabled, institution staff will have :ref:`access to the reports page for users in their institutions `. This page is normally restricted to administrators and lists extra user information including page access lists. .. note:: If you use your own avatar server to provide profile pictures for your users, you can use that instead of Gravatar for the default profile pictures. In order to do so, you need to add ``$cfg→remoteavatarbaseurl = 'http://example.com/avatar/';`` (with the correct URL to your service) to your config.php. .. index:: pair: Site administration; Search settings .. _search_settings: Search settings ^^^^^^^^^^^^^^^^^^ Mahara comes with a search plugin that allows you to search for users and pages. If you install another search plugin, you will be able to select which one to use for your site. .. figure:: /images/site_admin/search_settings.* :alt: Search settings Search settings .. note:: The internal search plugin can be configured in the *Plugin administration*. .. index:: Public group, Group category pair: Site administration; Group settings .. _group_settings: Group settings ^^^^^^^^^^^^^^^^^^^^ Mahara cannot only be used for individual work but also to work collaboratively in groups. Some settings are available in that area. .. figure:: /images/site_admin/group_settings.* :alt: Group settings Group settings #. **Create groups**: You decide whether administrators, administrators and staff or everyone can create groups. The default setting is the most permissive "everyone" because Mahara is user-centered and gives the individual users a great deal of control over what they want to do. If you choose to limit the group creation to administrators (and staff), these need to be contacted to set up groups. There is no internal group request system. #. **Create public groups**: Choose whether everyone or only administrators can create :ref:`public groups `. These are groups for which you do not need to be a member of the group or even have a login to Mahara to view the group homepage, discussion forums (and member listing if the group administrator allowed that). #. **Allow group categories**: If checked, administrators can create categories for users to assign to their groups. These categories can be used to filter groups in :ref:`My groups ` and :ref:`Find groups `. .. index:: Multiple institutions; Institution expiry; Auto-suspend expired institutions pair: Site administration; Institution settings .. _institution_settings: Institution settings ^^^^^^^^^^^^^^^^^^^^^^^^ You can use Mahara with multiple institutions and separate them for administrative purposes, e.g. user management and permissions, and to give them a different theme. .. figure:: /images/site_admin/institution_settings.* :alt: Institution settings Institution settings #. **Users allowed multiple institutions**: If checked, users can be members of several institutions at the same time. * **Advantage**: A user who belongs to two or more institutions only needs one account. * **Disadvantage**: If one or more institutions use custom themes, the user cannot choose which one is displayed for him. #. **Warning time for institution expiry**: If set, a notification will be sent to site and institution admins this amount of time before an institution is due to expire and be suspended. This time may be specified in days, weeks, months, years or "No end date". If the latter option is chosen, institutions will not expire by default. #. **Auto-suspend expired institutions**: If set, this option will allow Mahara to automatically suspend an institution that has expired automatically. This means that users of that institution will not be able to log in until the institution has been unsuspended. .. index:: Default account lifetime, Default account inactivity time, Session lifetime, Warning time for inactivity / expiry pair: Site administration; Account settings .. _config_site_account_settings: Account settings ^^^^^^^^^^^^^^^^^^^^^^ .. figure:: /images/site_admin/account_settings.* :alt: Account settings Account settings #. **Session lifetime**: For security reasons, after a specified period of inactivity, a user will be logged off the site automatically. This field specifies this time in minutes. The default value is 1440 minutes (24 hours). #. **Default account lifetime**: If set, user accounts will expire after this amount of time from when they were created. When a user account is expired, the user cannot log in. This time may be specified in days, weeks, months, years or "No end date". If the latter option is chosen, accounts will not expire by default. #. **Default account inactivity time**: If set, users who do not log in for this amount of time will be considered "inactive" and will not be able to log in anymore. This time may be specified in days, weeks, months, years or "No end date". If the latter option is chosen, users are not set to "inactive" by default. #. **Warning time for inactivity / expiry**: If set, a warning message will be sent to users this amount of time before their accounts are due to expire or become inactive. This time may be specified in days, weeks, months, years or "No end date". If the latter is chosen, users do not receive a warning before their account expires or they are flagged as having an inactive account. .. index:: Virus checking, ClamAV, Anti-spam, External resources in HTML pair: Site administration; Security settings .. _security_settings: Security settings ^^^^^^^^^^^^^^^^^^^^^ .. figure:: /images/site_admin/security_settings.* :alt: Security settings Security settings #. **Virus checking**: If you want all files uploaded by users to be run through the ClamAV virus scanner, you should select the virus checking option. You have to have `ClamAV `_ installed on your server. #. **Path to ClamAV**: The file system path to clamscan or clamdscan for virus checking. It is assumed that a failure of ClamAV to run will mean that a file should be treated as a virus, and a quarantine directory will be automatically set up by your Mahara installation. #. **Anti-spam**: There are three levels of anti-spam protection available for publicly visible forms, such as the contact and registration forms. A form submission is never silently rejected. Rather, an error message is displayed asking the user to try again if the submission is classified as spam. The three choices are: * **None**: No anti-spam checks are performed on form submissions. * **Simple**: Some basic checks are performed. Form submissions with email addresses that are not well-formed or that have an excessive number of URLs are rejected. * **Advanced**: Performs additional checks to determine whether email addresses are real or contain URLs that are blacklisted. This requires an Internet connection. #. **Enable Spamhaus URL blacklist**: If enabled, URLs will be checked against the Spamhaus DNSBL. The `Spamhaus Project `_ provides a URL blacklist that is free for non-commercial, low-traffic use. A professional use datafeed service is also available but not supported in Mahara. Please read the `Spamhaus DNSBL usage terms `_ before enabling this option. #. **Enable SURBL URL blacklist**: If enabled, URLs will be checked against the SURBL DNSBL. `SURBL `_ provides a URL blacklist that is free for organizations with fewer than 1000 users. A professional use datafeed service is also available, but not supported in Mahara. Please read the `SURBL usage terms `_ before enabling this option. #. **Disable external resources in user HTML**: Turning this option on will prevent users from embedding external resources such as images from remote sites into their forum posts and other HTML content. It is however a good thing to do from a security standpoint since it does neutralise a few clever phishing attacks. See the `HTML Purifier documentation `_ for more details. .. index:: pair: Site administration; Proxy settings .. _proxy_settings: Proxy settings ^^^^^^^^^^^^^^^^^^ .. figure:: /images/site_admin/proxy_settings.* :alt: Proxy settings Proxy settings #. **Proxy address**: If your site uses a proxy server to access the Internet, specify the proxies in ``hostname:portnumber`` notation. #. **Proxy authentication model**: Select your proxy's authentication model (none or basic [NCSA]), if appropriate. #. **Proxy credentials**: Enter the credentials required for your proxy to authenticate your web server in ``username:password`` format. .. index:: System mail address pair: Site administration; Email settings single: New in Mahara 1.5; Default notification method .. _email_settings: Email settings ^^^^^^^^^^^^^^^^ .. figure:: /images/site_admin/email_settings.* :alt: Email settings Email settings #. **SMTP host**: If you want to force Mahara to use a specific SMTP server instead of the system one, enter its hostname here, e.g. ``smtp.example.com``. It is possible to specify more than one host by separating them with semicolons, e.g. ``smtp1.example.com;smtp2.example.com``, but keep in mind that all other settings, e.g. authentication credentials and port numbers, will apply to all listed servers. It is not possible to specify different credentials for each server in this list. This feature is useful when SMTP host authentication is not required or you list different frontends for the same mail server in which case other settings will work. #. **SMTP port**: If your SMTP server uses a port number different from 25, you may specify it here. When encryption is enabled, the default ports are 465 for SSL and 587 for TLS. You only need to specify a port number if it is different from these. Check the correct settings with your mail service provider. #. **User**: If your SMTP server requires authentication, enter your username here. #. **Password**: If your SMTP server requires authentication, enter your password here. #. **SMTP encryption**: If your SMTP server supports encryption, enable it here. #. **System mail address**: This email address is the address that emails are sent from Mahara. #. |new15| **Default notification method**: Choose the notification method that is used for all notifications of new users on the site. The options are: * Email * Email digest * Inbox .. index:: Online users side block, Sitemap, Public profile, Public pages, Portfolio search, Tag cloud, Small page headers, Registration agreement, Mobile upload, HTML editor pair: Site administration; General settings single: New in Mahara 1.5; Automatically allow public profiles with public pages single: New in Mahara 1.5; Generate sitemap for public content single: New in Mahara 1.5; Limit the number of users in the "Online users" side block .. _general_settings: .. _small_headers: General settings ^^^^^^^^^^^^^^^^^^^ .. figure:: /images/site_admin/general_settings.* :alt: General settings General settings #. **Allow public pages**: If checked, users can create portfolio pages that are accessible to the public rather than only to logged-in users. #. **Allow public profiles**: If checked, users can set their profile pages to be accessible to the public rather than only to logged-in users. However, only logged-in users can use interactive features such as the wall. |new15| If the option "Allow public pages" is chosen, "Allow public profiles" is automatically selected. #. |new15| **Generate sitemap**: If checked, sitemap files from publicly accessible pages, groups and forum topics are generated that can be sent to another service. #. **Enable portfolio search**: If checked, the "Search my portfolio" side block is displayed in the *Content* and *Portfolio* sections of the site. #. **Enable tag cloud**: If checked, users see a side block in the *Content* and *Portfolio* sections of the site with a list of their most frequently used tags. The number of tags displayed is defined by the option "Maximum tags in cloud". #. **Maximum tags in cloud**: Enter the default number of tags to display in user tag clouds. Users can change this number in their :ref:`account settings `. #. **Small page headers**: If checked, a small header and site navigation block are displayed when viewing or editing portfolio pages instead of the standard header. This option gives more space for the portfolio content itself. #. **Show online users**: If checked, users see a side block with a list of the users who have been logged-in in the last 10 minutes (cf. the :ref:`dashboard `). #. |new15| **Online users limit**: Enter the maximum number of users to display in the *Online users* side block. #. **Registration agreement**: If checked, you force users to agree to the "Terms and Conditions" before registration. You should edit your site's "Terms and Conditions" page before enabling this option. You can do so under :ref:`Edit site pages `. #. **Allow mobile uploads**: If checked, users have the option of setting an authentication token in their :ref:`account settings `. That allows them to upload content from their :ref:`mobile devices `. #. **HTML editor**: Choose whether the HTML editor is used by default or not. If set to **User-defined**, users will be allowed to choose whether to use the HTML editor in their personal settings or not. Otherwise the specified setting will be used site-wide. .. index:: pair: Site administration; Site pages .. _edit_site_pages: Edit site pages ~~~~~~~~~~~~~~~~~~~ Here you can edit the content of some pages around the site and the pages linked to in the footer: * About * Home (Dashboard) * Logged-out home * Privacy statement * Terms and conditions All pages come with default text that you can change entirely. Every page must contain some text. You can use the visual editor to style your page. .. figure:: /images/site_admin/edit_site_pages.* :alt: Edit site pages Edit site pages #. **Page name**: Choose the page you want to edit from the drop-down menu. #. **Page text**: Change the text in the editor window. You cannot leave this field empty. #. Click the *Save changes* button. .. index:: pair: Site administration; Menu .. _menus: Menus ~~~~~~~~~~~~~ There are two menus in Mahara: * Links and resources * Footer .. index:: pair: Site administration; Links and resources .. _links_resources: Links and resources ^^^^^^^^^^^^^^^^^^^^^^^ The *Links and resources* menu appears to all users on most pages in the side bar. You can decide which links or files are available to everybody - also those without a login - and which ones only logged-in users shall see. .. figure:: /images/site_admin/menu_external.* :alt: Add external links to the menu Add external links to the *Links and resources* menu #. Choose which *Links and resources* menu you want to edit: the public or the logged-in users one. #. Choose the type *External link*. #. Give your link a name that will appear in the menu. #. Provide the full URL to the link including ``http://`` or ``https://``. #. Click the *Add* button. Once you have added links and files to your menus, you can edit or delete them. You can also link to files that you have uploaded to the :ref:`site files area `. .. figure:: /images/site_admin/menu_site_files.* :alt: Add site file to menu Add a site file to the *Links and resources* menu #. Choose which *Links and resources* menu you want to edit: the public or the logged-in users one. #. Choose the type *Site file*. #. Give your site file a name that will appear in the menu. #. Choose the file you want to display from the drop-down menu. #. Click the *Add* button. #. You can make changes to the name or choose a different file when you click on the *Edit* button. #. You can remove the file from the menu by clicking the *Delete* button. This will only delete the reference to the file in the menu but not the file itself. .. note:: If you wish to display your links and resources in a specific order, map that order out before you add the links and files because you cannot change the order afterwards. .. figure:: /images/links_resources.* :alt: Links and Resources menu *Links and resources* menu result .. index:: pair: Site administration; Footer single: New in Mahara 1.5; Override default site pages Footer menu ^^^^^^^^^^^^^^^^ You have control over which links are displayed in the footer on each page. .. figure:: /images/site_admin/menu_footer.* :alt: Footer menu Footer menu #. Select which site pages shall appear in the footer on each page. You can change the text of "Terms and conditions", "Privacy statement" and "About" in :ref:`Edit site pages `. #. If you want to link any of these pages to an existing external page, provide the URL in the respective text field. #. Click the *Save changes* button to save your settings. .. index:: MNet, Moodle, Mahoodle pair: Site administration; Networking single: New in Mahara 1.5; Generate new public key for MNet by deleting the existing one .. _networking: Networking ~~~~~~~~~~~~~ Mahara's networking features allow it to communicate with Mahara or `Moodle `_ sites. If networking is enabled, you can use it to configure single sign-on (SSO) for users who log in at either Moodle or Mahara or allow users from another Mahara instance to access yours. From Moodle 2.0 on you can connect Mahara and Moodle to save certain content you created in Moodle through the `portfolio feature `_. .. figure:: /images/site_admin/networking.* :alt: Networking Networking overview In order to use networking site-wide with any institution, you need to: #. **Enable networking**: Choose "Yes" from the drop-down menu. #. **Auto-register all hosts**: If you choose "Yes", an institution is created for any host that connects allowing these users to log in to your Mahara site. We recommend you leave the default "No" because that gives you more control over which Moodle or Mahara instances can connect. #. Click the *Save changes* button. #. |new15| **Delete this key**: Click the *Delete* button if you want to generate a new key for your Mahara site. Depending on which site you wish to connect, you may need to provide some of the other information on the page, in particular the *WWW root* and the *public key*. .. seealso:: The `comprehensive guide for setting up a Mahoodle `_ can be consulted when connecting Mahara and Moodle. You set up MNet for an institution when you :ref:`edit the authentication method XML-RPC `. .. index:: pair: Site administration; Site pages .. _site_pages: Pages ~~~~~~~~~~~~~ You create and copy site pages like regular :ref:`portfolio pages `. You do not have all blocks available. Check the :ref:`blocks in various contexts ` for blocks that you can use in site pages. .. figure:: /images/site_admin/site_pages.* :alt: Site pages Site pages Once you are done creating your site pages, you can share them with others on Mahara. .. index:: pair: Site administration; Share pages Share ~~~~~~~~~~~ You share site pages like any other page. .. seealso:: Refer to the :ref:`share options ` for regular portfolio pages for further information. .. figure:: /images/site_admin/share.* :alt: Share site pages Share site pages When you want to allow copying, you have a few more options available than on regular pages. .. figure:: /images/site_admin/share_copying.* :alt: Copying site pages Copying site pages #. **Allow copying**: Place a check mark here to see the following copying options. #. **Copy for new users**: All new users on the site - and not just in one institution - receive a copy of the selected page(s) into their portfolios. #. **Copy for new groups**: Select the **course** groups that have members, tutors and administrators if you want them to receive a copy of the selected page(s) #. **Copy for new groups**: Select the **standard** groups that have members and administrators if you want them to receive a copy of the selected page(s) .. index:: pair: Site administration; Site files .. _site_files: Files ~~~~~~~~~~~ Here you can upload files that you can include in the :ref:`links and resources ` menu or in :ref:`site pages `. You can add files that are in the home directory to the menu with resources for logged-in users. Files that you save in the *public* folder can be used in the menu for users who are not logged-in. .. seealso:: The process of uploading and managing files is very similar to files in your personal :ref:`files area `. .. figure:: /images/site_admin/site_files.* :alt: Site files Site files