# You must use a tab-size of 4 spaces to edit this file.
---
author_name: Tribal Systems
copyright_info: © Tribal Limited
editions: Pro, ProBusiness, Enterprise
start_running_on_install: false
license_info: 'Modified BSD License'
display_name: Extranet Base Module and Login
description: |
    <p>This module is the base module for creating an extranet, a secure area for authorised extranet users.</p>
    <p>When started, this module automatically creates a "Login" special page.</p>
    <p>The default behaviour is to have a single Login page, but on a multi-language site you may have a login page for each language.</p>
    <p>This module contains an option to remember the user's login name (by setting a cookie), and to keep the user logged in.</p>
    <p>Zenario supports groups, and roles (the relationship of users with locations) via the Organization Manager module.</p>
    <p>There is a User Redirector module, so that when a user logs in they can be redirected to the correct page, based on the User Redirector plugin settings. The redirection is based on group membership and roles.</p>
    <p>There are further modules, for: Registration, Password Reset, Change Password, Change Email, Edit Profile and Logout.</p>
category: management
keywords: base, extranet, login, password, private, user, users

# Reminder: you need to increment the LATEST_REVISION_NO in this module's
# latest_revision_no.inc.php file if you change any of the fields below:
vlp_class_name: zenario_extranet
css_class_name: zenario_extranet
is_pluggable: true
plugin_must_be_on_public_page: true
nestable: true
default_framework: standard
special_pages:
    special_page:
        page_type: zenario_login
        default_alias: login
        default_title: Login
        only_show_to_visitors_who_are_logged_out: true
        logic: create_and_maintain_in_default_language
        allow_hide: true

# Warning: adding a new dependency to an existing module will break any existing sites
# where the dependency is not running.
# You can fix this on a per-site basis by manually running the dependency, i.e. by running
#   UPDATE zenario_modules SET status = 'module_running' WHERE class_name = 'dependency'
# in MySQL and then going to /admin/ to apply database updates.
# If this is a core module, consider using runNewModuleDependency() in a 
# database-revision in zenario/admin/db_updates/step_4_migrate_the_data/plugins.inc.php
# to fix it automatically for every site.
dependencies:
    zenario_users: true
default_instance_name: Extranet Login
