Authentication

All Plugins / Core / Auth

Identity Card

StatusCore
Plugin LabelAuthentication
Short DescriptionOptions applied to all auth drivers
Plugin Identifiercore.auth
AuthorCharles du Jeu
Urldocs/references/plugins/core/auth
Dependencies

Documentation

Generic authentication options that are shared by all Auth plugins. Basically, determine whether users are enabled or not, guest user allowed or not, etc. Edited via the gui (Settings > Core options). Also provides the standard "auth" actions included by these plugins (login,logout).

You can select one or two Authentication plugin instances to provide auth backend to the application.
Default starter setup will typically use a unique SQL-based instance.
Default enterprise setup will often be composed of a Master / Slave configuration, Master being and LDAP or equivalent directory, slave being SQL-based to store the pydio-created users locally.

Plugin parameters

LabelDescriptionTypeDefault
Master slave *
instance_name
HiddenMASTER_SLAVE
Cache master users
CACHE_MASTER_USERS_TO_SLAVE
Create a local copy (at login time) of master users inside slave baseBooleantrue
User choice *
instance_name
HiddenUSER_CHOICE
Generic Features
Enable Users *
ENABLE_USERS
Activate the users management system to protect your Pydio installation.Booleantrue
Case Sensitive *
CASE_SENSITIVE
Whether the users identifiers should be case sensitive or not. WARNING, sql-based drivers will disable this by default, even if you check this.Booleantrue
Guest Browsing *
ALLOW_GUEST_BROWSING
Enable the 'guest' user, who does not need to log in.Booleanfalse
Password length *
PASSWORD_MINLENGTH
Minimum number of characters required for passwords in the applicationInteger8
Store Credentials in Session *
SESSION_SET_CREDENTIALS
Set the users credentials in the session after a successful login, this can be necessary when bridging specific auth and access plugins.Booleanfalse
Login Form
Secure Login Form *
SECURE_LOGIN_FORM
Raise the security of the login form by disabling autocompletion and remember me featureBooleanfalse
Enable Forgot Password *
ENABLE_FORGOT_PASSWORD
Add a Forgot Password link at the bottom of the login formBooleanfalse
Forgot Password Action *
FORGOT_PASSWORD_ACTION
Action to trigger when clicking on Forgot Password. Can be changed to trigger a custom action if you rely on external authentication system.Stringreset-password-ask
Disable Brute Force Check (Captcha)
DISABLE_BRUTE_FORCE_CHECK
Disable the check of failed login attempts, will disable the Captcha displayBooleanfalse
Main Instance
Instance Type *
MASTER_INSTANCE_CONFIG
Choose the configuration pluginPlugin_instance:authauth.sql
Multiple Instances Mode
Mode *
MULTI_MODE
Master/slave will assume that the master is read-only, and the slave is a local alternative to allow sharing features. User Choice will allow the user to manually choose its authentication method at startup.Group_switch:multimodeMASTER_SLAVE
Users Listing
MULTI_USER_BASE_DRIVER
In Master_Slave mode, use this option to limit the users listing in the administration to one driver only (leave empty if you want to see all users)Select (master, slave, both)
Secondary Instance (optional)
Separator
MULTI_USER_ID_SEPARATOR
This is necessary to discriminate users data loaded from various sources. Warning, use foldername compliant characters. For example :: does not work!String_-_
Master Authentication Label
MULTI_MASTER_LABEL
Will be shown to the user at loginStringCompany Users
Slave Authentication Label
MULTI_SLAVE_LABEL
Will be shown to the user at loginStringGuest Users
Secondary Instance Driver
Instance Type
SLAVE_INSTANCE_CONFIG
Choose the configuration pluginPlugin_instance:auth