Plugins

Introduction

Pydio comes fully loaded with various plugins to ease the integration with other systems, help you develop your own specific installation, or even use Pydio as a very generic explorer-like GUI, for browsing any type of data.

Plugins can be seen as « features ». They come packed with their own actions and parameters, and can drastically change the way Pydio works.  A plugin is composed of a folder « plugintype.pluginname » containing at least an XML file describing the plugin, the manifest.xml. When you want to customize, duplicate, understand a plugin, a good start is always to look at the manifest.xml. A plugin can come with various resources : PHP code, Javascript, images, internationalisation data, etc. All these are always declared in the manifest.xml.

How to install?

Most plugin come directly from the core, and you don’t have anything to do to « install » them. If you have downloaded a plugin, then drop it inside the plugins folder of the application, and clear your cache (see below). All plugins can be activated and configured through the GUI, in the Settings section (accessible as administrator only).

Clearing the cache

Warning, since the gathering of all manifest.xml files into one huge XML registry is CPU intensive, there is a cache mechanism to avoid parsing these file at each request. This implies that when you make changes to a plugin, you’ll have to delete the two new cache files located in the data/cache folder : plugins_*.ser (3 files). If you’re developing, you’ll want to disable this cache totally. This possible by setting the AJXP_SKIP_CACHE to « true » inside conf/bootstrap_context.php.

Since version 4, another way to automatically clear the cache is simply editing one of the plugins configuration accessible in the GUI via Settings > Plugins Options (for example disable/re-enable a plugin).

Plugins list

In this section, all the plugins available to extend Pydio features are listed. Each plugin has its own forum thread embedded in the page, please use it to add any comment that could be helpfull for other users.

Core plugins
Access plugins
  • User Dashboard : User home dashboard, can be displayed before accessing to workspaces.
  • File System (Standard) : The most standard access to a filesystem located on the server..
  • HPCloud (HPCloud Driver) : Access HPCloud (Open Stack) Object Storage.
  • FTP over SSH : Access a remote server filesystem using FTP via SSH server. Handy for working around permissions problems..
  • Mailbox (Imap or POP) : This plugin will browse the content of a mailbox (imap or pop) and allow to grab emails attachments and copy them to another repository. Requires the PHP IMAP extension..
  • Samba : Browse a Samba Server.
  • Remote Server (via API) : Access a remote server implementing the Pydio API (most commonly a remote server with another Pydio installed).
  • FTP Server : This driver can access a remote FTP server.
  • S3 (Amazon Web Service) : Access an AWS server. Requires AWS-SDK for PHP .
  • SSH File Transfer Protocol (SFTP) : The SSH File Transfer Protocol is a network protocol that provides file access, file transfer, and file management functionalities over SSH2..
  • WebDAV (PEAR) : Access a WebDAV server. Requires PEAR/HTTP_WebDAVClient installed with the patched found in the plugin folder applied..
  • Demo (no write actions) : This is a standard access to the filesystem but with all write actions disabled server-side..
  • Dropbox : This plugin allows accessing a dropbox account. Still experimental, requires PEAR/HTTP_OAuth extension..
  • Admin Driver : Access Pydio configuration data..
  • WMS Server : Browse the layers served by a WMS server..
  • Javascript Api Browser : Browse AjaXplorer Javascript classes and interfaces. Helper for developpers, but also good demonstration of how Ajaxplorer data can be fed by something different than a remote server filesystem!.
  • Mysql Database : This driver can browse and update tables and records in a MySQL database, kind of phpMyAdmin..
  • Shared Elements (deprecated) : Browse user shared elements. Replaced by User Dashboard.
Action plugins
  • Tasks Scheduler : Register tasks to be run on a regular basis instead of writing them one by one in cron tab..
  • Skeleton Plugin : This is an empty container to demonstrate the basics of plugins coding..
  • Quick Send (experimental) : Send, share and email the link at once, from the user dashboard..
  • Sharing Features : Share Center actions and hooks.
  • Power FS : This set of extensions assume that you have an administration access to your server: ability to tweak the webserver and the php configuration, ability to access the command line, etc..
  • Update Engine : Automatic update of Pydio. Since version 3.3.3.
  • Antivirus : antivirus plugin adaptor.
  • Selection Cart : Select files to a cart and download/share all at once.
  • Avatars : Get user avatar from Gravatar/Libravatar.
  • timestamp : Allow timestamp files with Universign..
Auth plugins
Boot plugins
  • : .
Conf plugins
  • Serialized Files : Stores the conf data as serialized PHP values on the filesystem..
  • DB Storage : Stores the conf data in an SQL database..
Cypher plugins
  • Encfs Mount : Dynamically create/mount/umount an encfs filesystem.
Downloader plugins
Editor plugins
  • Image viewer : Image viewer, used for previewing images and browsing them in a diaporam. Generates a thumbnail version of the images..
  • Sound Player : Inserts a flash player for reading mp3 files online, and playing a whole folder in a separate window..
  • EXIF Extractor : Display the Exif metadata contained inside the JPG files. Can locate the image on a map if it contains geolocation data..
  • Etherpad : Collaborative edition of text files.
  • Source Viewer : Syntax Highlighter for all major code source files.
  • Role Editor : Administrator Role Editor.
  • Text Editor : Very basic text editor.
  • Open in... : Simple Picker to open any type of file in any available editor..
  • Email Viewer : Email reader, supports eml format and eml mimetypes. Detects if a folder contains only email and display columns accordingly..
  • Plugin Editor : Plugin Editor.
  • Open Documents Viewer : Open Document Formats viewer - based on WebODF.js library.
  • Info Panel... : Info Panel.
  • Pixlr Editor : Bridge to the Pixlr.com webservice that allow online image edition via a photoshop-like GUI..
  • Image Magick : Image Magick viewer supports PDF and various images formats preview. Requires external library to be installed on the server..
  • External Window : Open file in a new browser window, thus using native browser capabilities..
  • Sound Player : Uses HTML5 or Flash to play a sound.
  • CKEditor : Wysiwyg HTML Editor, requires separate library to be downloaded..
  • Office Docs : Zoho editor.
  • Repository Editor : Repository Editor.
  • Video Player : Inserts a video player in the info panel, either HTML5 or Flash depending on the format..
  • CodePress : Legacy Syntax Highlighter.
  • Map viewer : Geolocation feature to either display a WMS layer or simply place an exif-localized photo. Requires OpenLayers.
Feed plugins
  • Events SQL : Use an SQL based storage for persisting all user-space event logs.
Gui plugins
  • Client Plugin : Browser-based rich interface. Contains configurations for theming, custom welcome message, etc..
  • Backbone : Backbone.
  • Light : Simple Template for Bookmarklets.
  • Mobile : Template extending gui.ajax for small screen terminals..
  • iOS : Template for redirecting to iPhone application.
  • User access point : User access point.
Index plugins
  • Lucene Search Engine : Zend_Search_Lucene implementation to index all files and search a whole workspace quickly..
Log plugins
Mailer plugins
Meta plugins
  • Exif Metadata : Extracts the EXIF metadata of a JPG image. Used in conjunction with editor.exif.
  • Comments Feed : Display a chat-like feed on all nodes.
  • File Hasher : Compute on-demand a hash of the file content and stores it in the metadata if a metastore is provided.
  • Subversion Repository : Extract SVN informations (revision, change log, etc) if the workspace is a Working-Copy, and SVN is available as a commandline..
  • FS Mount : Mount a remote location on the file system before accessing the workspace.
  • Syncable Workspace : Track changes on this workspace to enable the synchronization with an external client.
  • User quota : Maintain the size of a given directory for each user.
  • Watch Metadata : Register watched on files or folders.
  • Git-based Versioning : Keep tracks of all files modifications using a local Git repository.
  • Text Metadata : Simple metadata implementation stored in a hidden file..
  • Simple Lock : Manual Locking mechanism to avoid concurrent edition.
Metastore plugins
Mq plugins
  • MQ SQL : Store persistant and worker queues in database.
  • MQ Serial : Store persistant and worker queues in serial files.
Notify plugins
Shorten plugins
Uploader plugins
  • Jumploader : Third-party JumpLoader JAVA applet allowing to upload folders, chunk big files, etc..
  • Flash uploader : Legacy flash uploader, used when the browser does not support HTML5. If you want to force the usage of this uploader, deactivate the uploader.html, and remove the activeCondition tag from the uploader.flex manifest file..
  • PlUpload Support : PlUpload uploader support. Requires downloading and installing the PLupload sources..
  • HTML Uploader : Auto-switching HTML5 or IFrame uploader..