Client Plugin

All Plugins / Gui / Ajax

Identity Card

StatusCore
Plugin LabelClient Plugin
Short DescriptionBrowser-based rich interface. Contains configurations for theming, custom welcome message, etc.
Plugin Identifiergui.ajax
AuthorCharles du Jeu
Urldocs/references/plugins/gui/ajax
Dependencies

Documentation

This is the default web interface displayed when accessing Pydio via a browser. It's HTML5 compliant and powered by the PrototypeJS library. The whole interface is built dynamically based on the various configurations gathered through all the application plugins.

The interface is themeable, you create new theme by duplicating the folders below res/themes/. Theming should be basically CSS tweaking. At the moment, "umbra" (latest) and "oxygen" (legacy) themes are bundled with the application, and you can change the theme by accessing the plugin options.

Although not necessary, at the moment the other gui plugins rely on this one to load all the core JS classes and bootstrap the Pydio framework in the client.

UI Screenshot

Plugin parameters

LabelDescriptionTypeDefault
Main Options
Theme *
GUI_THEME
Theme used for displaySelect (orbit)orbit
Additional JS frameworks
JS_RESOURCES_BEFORE
List of comma separated pathes to JS files, which must be loaded BEFORE the main Pydio framework is loaded. The preferred way should be using plugin resources declarations. Loading JS files at the very start up of the page might be option in some cases only.Stringplugins/gui.ajax/res/js/jquery_backbone-min.js
Display Branding Tool
DISPLAY_VANITIZER_TOOL
Show the palette on the interface to change the interface colors and logos. Make sure to reload the interface if you toggle this option.Booleanfalse
Use configured branding
USE_DEFINED_BRANDING
Override default styles and colors with the options defined in the branding tool. Make sure to reload the interface if you toggle this option.Booleantrue
Login Page
Welcome Message
CUSTOM_WELCOME_MESSAGE
An additional message displayed in the start up screenStringWelcome to Pydio
Icon Only
CUSTOM_ICON_ONLY
Skip the title, only display an imageBooleantrue
Custom Icon
CUSTOM_ICON_BINARY
URI to a custom image to be used as start up logoImage
Icon Path (Legacy)
CUSTOM_ICON
URI to a custom image to be used as start up logoStringplugins/gui.ajax/res/themes/orbit/images/LoginBoxLogo.png
Icon Width
CUSTOM_ICON_WIDTH
Width of the custom image (Default 35px)String250px
Icon Height
CUSTOM_ICON_HEIGHT
Height of the custom icon (with the px mention)String120px
Title Font Size
CUSTOM_FONT_SIZE
Font sized used for the title in the start up screenString
User Home Logo
CUSTOM_DASH_LOGO
Replace the logo displayed in the welcome pageImage
Top Toolbar
Title
CUSTOM_TOP_TITLE
Append a title to the image logoString
Logo
CUSTOM_TOP_LOGO
Replace the top left logo in the top toolbarImage
Logo Height
CUSTOM_TOP_LOGO_H
Manually set a logo heightInteger39
Logo Width
CUSTOM_TOP_LOGO_W
Manually set a logo widthInteger
Logo Top
CUSTOM_TOP_LOGO_T
Manually set a top offsetInteger4
Logo Left
CUSTOM_TOP_LOGO_L
Manually set a left offsetInteger6
Web Session
Client Timeout
CLIENT_TIMEOUT_TIME
The length of the client session in SECONDS. The server session length will be used by default. In most PHP installations, the session length is set to 1440 seconds (24 minutes). You can set this value to 0. This will make the client session 'infinite' by pinging the server periodically. This keeps the PHP session alive. For evident security reasons, this is not a recommended setting.Integer
Warning before session expires
CLIENT_TIMEOUT_WARN
Number of MINUTES before the session expiration for issuing an alert to the userInteger3
Google Analytics Analytics ID
GOOGLE_ANALYTICS_ID
Id of your GA account, something like UE-XXXX-YYString
Google Analytics Analytics Domain
GOOGLE_ANALYTICS_DOMAIN
Set the domain for your analytics reports (not mandatory!)String
Google Analytics Analytics Events
GOOGLE_ANALYTICS_EVENT
Use Events Logging, experimental only implemented on download action in PydioBooleanfalse
Page Background Images
Custom background (1)
WELCOME_PAGE_BACKGROUND_1
Image used as a backgroundImage
Background attributes (1)
WELCOME_PAGE_BACKGROUND_ATTRIBUTES_1
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:140%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:140%;background-position:50% 50%;
Custom background (2)
WELCOME_PAGE_BACKGROUND_2
Image used as a backgroundImage
Background attributes (2)
WELCOME_PAGE_BACKGROUND_ATTRIBUTES_2
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:140%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:140%;background-position:50% 50%;
Custom background (3)
WELCOME_PAGE_BACKGROUND_3
Image used as a backgroundImage
Background attributes (3)
WELCOME_PAGE_BACKGROUND_ATTRIBUTES_3
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:140%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:140%;background-position:50% 50%;
Custom background (4)
WELCOME_PAGE_BACKGROUND_4
Image used as a backgroundImage
Background attributes (4)
WELCOME_PAGE_BACKGROUND_ATTRIBUTES_4
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:140%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:140%;background-position:50% 50%;
Custom background (5)
WELCOME_PAGE_BACKGROUND_5
Image used as a backgroundImage
Background attributes (5)
WELCOME_PAGE_BACKGROUND_ATTRIBUTES_5
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:140%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:140%;background-position:50% 50%;
Custom background (6)
WELCOME_PAGE_BACKGROUND_6
Image used as a backgroundImage
Background attributes (6)
WELCOME_PAGE_BACKGROUND_ATTRIBUTES_6
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:140%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:140%;background-position:50% 50%;
Low-Resolution Background
WELCOME_PAGE_BACKGROUND_LOWRES
Make sure to use a smaller resolution image, otherwise mobile loading is very slow.Image
Background Attributes (Low Resolution)
WELCOME_PAGE_BACKGROUND_ATTRIBUTES_LOWRES
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:140%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:140%;background-position:50% 50%;
Minisite
Custom background (1)
CUSTOM_SHAREPAGE_BACKGROUND_1
Image used as a backgroundImage
Background attributes (1)
CUSTOM_SHAREPAGE_BACKGROUND_ATTRIBUTES_1
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:100%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:100%;background-position:50% 50%;
Custom background (2)
CUSTOM_SHAREPAGE_BACKGROUND_2
Image used as a backgroundImage
Background attributes (2)
CUSTOM_SHAREPAGE_BACKGROUND_ATTRIBUTES_2
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:100%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:100%;background-position:50% 50%;
Custom background (3)
CUSTOM_SHAREPAGE_BACKGROUND_3
Image used as a backgroundImage
Background attributes (3)
CUSTOM_SHAREPAGE_BACKGROUND_ATTRIBUTES_3
Attributes of the image used as a backgroundSelect (background-repeat:no-repeat;background-position:50% 50%;, background-repeat:repeat;background-size:100%;background-position:50% 50%;, background-repeat:no-repeat;background-size:100%; background-position:center center;, background-repeat:repeat;)background-repeat:repeat;background-size:100%;background-position:50% 50%;
Minisite Logo
CUSTOM_MINISITE_LOGO
Top-right logo displayed on minisite pageImage