Aurora Files documentation

Modules settings reference

Various features and functionality aspects of Aurora Files are provided by different modules. Each module has its configuration file under data/settings/modules/ directory.

ActivityHistory

Disabled
Setting to true disables the module
AvailableFor
Automatically provide this feature if one of the listed modules is requested by the entry point

AdminAuth

Disabled
Setting to true disables the module
SuperadminWhitelistIp
If non-empty, only listed IPs are allowed access from
AllowLoginFromCoreModule
If set to true, superadmin account is allowed to log into main login page

AdminPanelWebclient

Disabled
Setting to true disables the module
EntitiesPerPage
Number of items (users, domains etc.) shown per page in admin interface
TabsOrder
Defines list of adminpanel interface sections and the order of displaying those
EntitiesOrder
Defines list of top menu entries and the order of displaying those

BrandingWebclient

Disabled
Setting to true disables the module
LoginLogo
URL of logo image used on login page
TabsbarLogo
URL of logo image used in top left corner of main interface
TopIframeUrl
URL of iframe displaying custom content (e.g. advertisement) on top of main interface
TopIframeHeightPx
Height of iframe with custom content, in pixels

Contacts

Disabled
Setting to true disables the module
ContactsPerPage
Number of contacts displayer ped page
ImportContactsLink
URL of documentation page that explains structure of CSV files used
AllowAddressBooksManagement
Setting to true enables managing multiple address books
AllowEditTeamContactsByTenantAdmins
Setting to true allows tenant admin to edit Team address book entries

ContactsWebclient

Disabled
Setting to true disables the module
AvailableFor
Automatically provide this feature if one of the listed modules is requested by the entry point

Core

Disabled
Setting to true disables the module
AllowCapa
If set to true, product features can be enabled/disabled on user or tenant level
AllowPostLogin
If set to true, credentials can be submitted via POST request
CsrfTokenProtection
If set to true, CSRF protection is enabled
CronTimeToRunSeconds
Defines intervals in seconds to run a routine of deleting temporary files
CronTimeToKillSeconds
Defines minimal age in seconds of temporary files to be deleted
CronTimeFile
Defines filename for storing last timestamp when routine of deleting temporary files was run
UserSelectsDateFormat
If set to true, users can select date format
DateFormat
Defines default date format used
DateFormatList
Defines default date format used
GetAccountWithPassword
LanguageListComment
LanguageList
Empty array means that every language from every module will be available. ["English", "German"] means that only English and German languages will be used in the system.
Language
Default interface language used
AutodetectLanguage
Setting to true enables language autodetection
PostLoginErrorRedirectUrl
If login credentials were supplied with POST method, this setting defines redirect URL used when authentication error occurs
TimeFormat
Denotes time format used by default
SiteName
Text used in browser title as a website name
ProductName
Product name, displayed in About tab of adminpanel
AuthTokenCookieExpireTime
Expiration time for authentication cookie, in days
EnableFailedLoginBlock
Setting to true enables feature of blocking user after a number of failed login attempts
LoginBlockAvailableTriesCount
Number of failed login attempts which will result in blocking user
LoginBlockDurationMinutes
Number of minutes user will be blocked for upon multiple failed login attempts
AllowGroups
Setting to true enables user groups which can be managed in adminpanel

CoreExtender

Disabled

CoreParanoidEncryptionWebclientPlugin

Disabled
Setting to true disables the module
AvailableFor
Automatically provide this feature if one of the listed modules is requested by the entry point
EnabledByDefault
If true, the feature is enabled for new users
EnableInPersonalStorageByDefault
If true, the feature is enabled for new users in personal storage by default
ChunkSizeMb
Sets a chunk size used for encrypting files, in Mbytes
AllowMultiChunkUpload
Defines whether the files can be uploaded in chunks or in full
AllowChangeSettings

CoreWebclient

Disabled
Setting to true disables the module
AllowChangeSettings
If true, users are allowed to select theme, language etc. in common settings screen
AllowClientDebug
Enables clientside debug logs, viewed by entering window.auroraLogs in browser console
AllowDesktopNotifications
Enables desktop notifications, the value is applied to new user accounts
AllowIosProfile
Enables retrieving account profile download when logging into web interface from iOS device
AllowMobile
Enables mobile version of web interface and automatically switches to it on Android or iOS smartphone
AllowPrefetch
Enables downloading message bodies in background, to display messages instantly upon selecting those
AttachmentSizeLimit
Attachment file size limit for upload, in bytes
AutoRefreshIntervalMinutes
Default value for auto refresh interval in minutes
ContentSecurityPolicy
Specifies CSP header used for protection from cross-site scripting, clickjacking, code injection attacks
CustomLogoutUrl
Specifies URL user will be redirected to upon logging out of their account
DefaultAnonymScreenHash
Hash ID of the screen available to non-logged in user by default
DefaultUserScreenHash
Hash ID of the screen available to logged in user by default
GoogleAnalyticsAccount
If specified, Google Analytics code will be loaded with this account ID used
HeaderModulesOrder
Denotes the list of top menu items in the order how they're displayed
IsDemo
Enables warnings of demo limitations, used by various modules
LanguageNames
Mapping of language names and their local translations
MultipleFilesUploadLimit
Defines a limit for number of files uploaded during a single user request
ShowQuotaBar
If true, indicator of disk space usage by email or files will be displayed in the interface
ShowQuotaBarTextAsTooltip
If true, quota information will only be shown as the tooltip of the indicator; if false, it's shown directly in the interface
QuotaWarningPerc
Enables warning if percentage of free disk space for email account is less than this value
SyncIosAfterLogin
Theme
Theme used by default
ThemeList
List of themes available
HideLogout
If true, Logout link will be hidden
IncludeInMobile
If true, the module is used in mobile version of the interface

CorporateFiles

Disabled
Setting to true disables the module
SpaceLimitMb
Disk space allocated for corporate file storage, in Mbytes

Dav

Disabled
Setting to true disables the module
AdminPrincipal
CaldavNotification
FilesSharing
LogBody
UseBrowserPlugin
If true, allows for accessing DAV URL from web browser and navigating the account structure and data
UseDigestAuth
If true, enables the use of Digest auth instead of default Basic auth
ExternalHostNameOfDAVServer
Denotes hostname for DAV server access
UseFullEmailForLogin
If true, full email address is used for DAV login; if fals, username part of email address is used
DomainForLoginWithoutEmail
If UseFullEmailForLogin is false, this value denotes domain part of user's email address

DavContacts

Disabled
Setting to true disables the module

Dropbox

Disabled
Setting to true disables the module
EnableModule
Setting to true allows for using and configuring the module
Id
App ID (App key) obtained from Dropbox app
Secret
App secret obtained from Dropbox app

DropboxAuthWebclient

Disabled
Scopes

DropboxFilestorage

Disabled
Scopes

EavObjectViewer

Disabled

ExternalClientsLoginFormWebclient

Disabled
IncludeInDesktop

Facebook

Disabled
Setting to true disables the module
EnableModule
Setting to true allows for using and configuring the module
Id
App ID obtained from Facebook Developer console
Secret
App Secret obtained from Facebook Developer console

FacebookAuthWebclient

Disabled
Scopes

FileViewerWebclientPlugin

Disabled

Files

Disabled
Setting to true disables the module
EnableUploadSizeLimit
If true, upload file size limit is set
UploadSizeLimitMb
Upload file size limit value, in Mbytes
UserSpaceLimitMb
Default filestorage disk space quota for new user accounts created
TenantSpaceLimitMb
With multitenancy enabled, default tenant space quota; with multitenancy disabled, total disk space quota for the installation

FilesCutCopyPasteWebclientPlugin

Disabled
Setting to true disables the module

FilesTableviewWebclientPlugin

Disabled
Setting to true disables the module

FilesWebclient

Disabled
Setting to true disables the module
EditFileNameWithoutExtension
If true, only filename can be changed when renaming file while extension is kept intact
ShowCommonSettings
If true, allow for changing basic settings of files functionality, such as enabling table view and preview pane
ServerUrlRewriteBase
ServerUseUrlRewrite
ShowFilesApps
Enables displaying information on desktop and mobile file storage apps in Files tab of Settings screen
BottomLeftCornerLinks
AvailableFor
Automatically provide this feature if one of the listed modules is requested by the entry point
PublicLinksEnabled
If true, allows for creating basic Public links in addition to secure ones

FilesZipFolder

Disabled
Setting to true disables the module

Google

Disabled
Setting to true disables the module
EnableModule
Setting to true allows for using and configuring the module
Id
App ID obtained from Google app settings
Secret
App secret obtained from Google app settings
Key
API key obtained from Google app settings

GoogleAuthWebclient

Disabled
Scopes

GoogleDrive

Disabled
Scopes

InvitationLinkWebclient

Disabled
Setting to true disables the module
RegisterModuleName
Denotes the module used for providing signup interface
LoginModuleName
Denotes the module used for providing login interface
EnableSendInvitationLinkViaMail
If true, the module will be sending invitation links via email
NotificationType
Denotes how the mail is sent - mail for standard mail() function of PHP, smtp for sending via SMTP protocol
NotificationEmail
Sender email address used in mail messages sent by this module
NotificationHost
SMTP server host used for sending mail by this module
NotificationPort
SMTP server port number
NotificationUseAuth
If true, SMTP authentication is used to connect to SMTP server
NotificationLogin
Username used to authenticate on SMTP server
NotificationPassword
Password used to authenticate on SMTP server
SMTPSecure
Set to 'ssl' or 'tls' to use SSL or STARTTLS respectively

Ios

Disabled
Setting to true disables the module
IncludeInMobile
If true, the module is used in mobile version of the interface
IncludePasswordInProfile
If true, password will be included when offering iOS profile download
AllowIosProfile
SyncIosAfterLogin

LogsViewerWebclient

Disabled
Setting to true disables the module
AppName
AuthMode
TokenMode
Url
ViewLastLogSize
Defines size of the log file section to view, in bytes

Min

Disabled
Setting to true disables the module

MobileAppsWebclient

Disabled
Setting to true disables the module
FilesSectionName
Title of Files section in Mobile Apps tab of Settings screen
ShowFilesAndroidApp
If true, display a link to Aurora Files for Android
ShowFilesServerUrlApp
If true, display URL which needs to be supplied in mobile apps to access files
FilesAndroidAppLink
URL of a link to Aurora Files for Android
ShowFilesIosApp
If true, display a link to Aurora Files for iOS
FilesIosAppLink
URL of a link to Aurora Files for iOS
ShowFilesWinApp
If true, link to Windows client for accessing files is shown
FilesWinAppLink
URL of a link to Windows client for accessing files
MailSectionName
Title of Mail section in Mobile Apps tab of Settings screen
ShowMailServerUrlApp
If true, display the URL for accessing this product installation
ShowMailAndroidApp
If true, display a link to Aurora Mail for Android
MailAndroidAppLink
URL of a link to Aurora Mail for Android
ShowMailIosApp
If true, display a link to Aurora Mail for iOS
MailIosAppLink
URL of a link to Aurora Mail for iOS

MobileSync

Disabled
Setting to true disables the module

MobileSyncWebclient

Disabled
Setting to true disables the module

OAuthIntegratorWebclient

Disabled
AuthModuleName
OnlyPasswordForAccountCreate
AllowNewUsersRegister

OEmbedFiles

Disabled
Setting to true disables the module

OfficeDocumentEditor

Disabled
Setting to true disables the module
IncludeInMobile
If true, the module is used in mobile version of the interface
ExtensionsToView
List of file types which can only be viewed by OnlyOffice
ExtensionsToConvert
List of file types which can only be edited by OnlyOffice into a different format, and target format specified for each entry
ExtensionsToEdit
List of file types which can be edited by OnlyOffice
DocumentServerUrl
OnlyOffice installation URL
Secret
Secret token needs to be specified here if JWT protection is enabled on OnlyOffice
EnableHistory
Enables Version History feature of document editing
TrustedServerHost

OfficeDocumentViewer

Disabled
Setting to true disables the module
IncludeInMobile
If true, the module is used in mobile version of the interface
ExtensionsToView
Defines a list of file types which can be viewed by external web service
ViewerUrl
URL of external web service used for viewing files

OpenPgpFilesWebclient

Disabled
Setting to true disables the module
EnableSelfDestructingMessages
Enables feature of self-destructing messages
EnablePublicLinkLifetime
Enables feature of public link expiration
AvailableFor
Automatically provide this feature if one of the listed modules is requested by the entry point

OpenPgpWebclient

Disabled
Setting to true disables the module
AvailableFor
Automatically provide this feature if one of the listed modules is requested by the entry point

OverrideUserSettings

Disabled
Setting to true disables the module
Domains
Defines a list of domains, with a list of features disabled for each of those domains

PersonalContacts

Disabled
Setting to true disables the module

PersonalFiles

Disabled
Setting to true disables the module
UserSpaceLimitMb
Defines a default filesystem quota for user account, in Mbytes

RecaptchaWebclientPlugin

Disabled
Setting to true disables the module
PublicKey
Public key obtained at reCAPTCHA website
PrivateKey
Private key obtained at reCAPTCHA website
LimitCount
Denotes number of unsuccessful login attempts required for CAPTCHA to be displayed, 0 - always displayed
WhitelistIPs
List of IP addresses CAPTCHA is never be displayed for
IncludeInMobile
If true, the module is used in mobile version of the interface
IncludeInDesktop
If true, the module is used in desktop version of the interface
RequestMethod
Request method used by API

RocketChatWebclient

Disabled
Setting to true disables the module
ChatUrl
RocketChat installation URL
AdminUsername
Username of RocketChat admin account
AdminPassword
Password of RocketChat admin account
EnableLogging
Enables logging of API calls and responses to a separate logfile for troubleshooting purposes
AllowAddMeetingLinkToEvent
MeetingLinkUrl

S3CorporateFilestorage

Disabled
Setting to true disables the module

S3Filestorage

Disabled
Setting to true disables the module
AccessKey
S3 storage access key
SecretKey
S3 storage secret key
Region
S3 storage region
Host
S3 storage hostname
BucketPrefix
Bucket prefix you wish to be used
PresignedLinkLifetimeMinutes
RedirectToOriginalFileURLs
If true, files on S3 storage are obtained via redirect to their actual URLs

SettingsWebclient

Disabled
Setting to true disables the module
TabsOrder
Defines list of tabs and the order they're displayed in

SharedContacts

Disabled
Setting to true disables the module

SharedFiles

Disabled
Setting to true disables the module
SpaceLimitMb

StandardAuth

Disabled
Setting to true disables the module

StandardAuthWebclient

Disabled
Setting to true disables the module
IncludeInMobile
If true, the module is used in mobile version of the interface

StandardLoginFormWebclient

Disabled
Setting to true disables the module
ServerModuleName
Defines name of the module responsible for login page
HashModuleName
Defines hash of the module responsible for login page
CustomLoginUrl
DemoLogin
If set, denotes email address of predefined demo account
DemoPassword
If set, denotes password of predefined demo account
InfoText
Defines additional text message shown on login page
BottomInfoHtmlText
Defines bottom text message shown on login page
LoginSignMeType
AllowChangeLanguage
Enables changing language on login page
UseDropdownLanguagesView
If true, language selector is presented as a dropdown menu
AuthTokenCookieExpireTime
Sets authentication token expiry time, in days

StandardRegisterFormWebclient

Disabled
Setting to true disables the module
ServerModuleName
Defines name of the module responsible for registration page
HashModuleName
Defines URL hash used by the module
CustomLogoUrl
Defines URL of logo image used on registration page
InfoText
Defines additional text message shown on registration page
BottomInfoHtmlText
Defines bottom text message shown on registration page

TeamContacts

Disabled
Setting to true disables the module

TwoFactorAuth

Disabled
Setting to true disables the module
ShowRecommendationToConfigure
If true, users will get a message suggesting to enable 2FA if it's not enabled in their accounts yet
AllowSecurityKeys
Enables support for security keys
FacetIds
List of app-key-hashes of mobile apps
AllowAuthenticatorApp
Enables use of authenticator app
ClockTolerance
Value set to N means that codes starting from N * 30sec ago to N * 30sec from now are accepted
AllowBackupCodes
If set to true, and if authenticator app or security key configured, users are able to use backup codes
AllowUsedDevices
Enables managing trusted devices
TrustDevicesForDays
Allows for expiry of trusted device list entries after certain amount of days
IncludeInMobile
If true, the module is used in mobile version of the interface
IncludeInDesktop
If true, the module is used in desktop version of the interface
RequireInMobile
List of other modules required by this module
© Copyright 2002-2024 Afterlogic Corp.