File System (Standard)

All Plugins / Access / Fs

Identity Card

StatusCore
Plugin LabelFile System (Standard)
Short DescriptionThe most standard access to a filesystem located on the server.
Plugin Identifieraccess.fs
AuthorCharles du Jeu
Urldocs/references/plugins/access/fs
Dependencies

Documentation

The default and basic "FileSystem" driver, used to browse, edit, manage, etc all documents contained on a local file system. The default repository bundled with Pydio is using this driver.

FS Driver implements all the standard actions of Pydio, including upload/download, moving the files in various ways. It registers the stream "ajxp.fs" in the application, that is able to read both local filesystem and zip archives (using PclZip included in the core).

Being the most standard access driver, it comes with an important set of options that can be configured either at a plugin level ("Plugin parameters") or at a repository level ("Instance Parameters"). Please review them carefully, as many of the common usage problems can often be solved by tweaking these options.

Actions of this driver are not inside the manifest.xml (too big) but in a separate file, fsActions.xml. It's a good starting point to have a look at this file when you want to hack something in the application.

Plugin parameters

LabelDescriptionTypeDefault
Real Size Probing
PROBE_REAL_SIZE
Use system command line to get the filesize instead of php built-in function (fixes the 2Go limitation)Booleanfalse
Use POSIX
USE_POSIX
Use php POSIX extension to read files permissions. Only works on *nix systems.Booleanfalse
Zip downloading files on the fly
ZIP_ON_THE_FLY
Directly write the zip file to an output stream which is connected to the user's browser.Booleanfalse
Metadata and indexation
Default Metasources
DEFAULT_METASOURCES
Comma separated list of metastore and meta plugins, that will be automatically applied to all workspaces created with this driverStringmetastore.serial,meta.watch,meta.syncable,meta.filehasher,index.lucene
Filesystem Commons
Show hidden files
SHOW_HIDDEN_FILES
Show files beginning with a .Booleanfalse
Hide recycle bin
HIDE_RECYCLE
Whether to show the recycle bin folder. Unlike in the following options, the folder will be hidden but still writeable.Booleanfalse
Hide extensions
HIDE_EXTENSIONS
Comma-separated list of extensions to hide. Extensions, files and folders that are hidden are also access forbidden.Stringser
Hide folders
HIDE_FOLDERS
Comma-separated list of specific folders to hideTextarea
Hide files
HIDE_FILENAMES
Comma-separated list of specific files to hideTextareabootstrap.json

Instance parameters

LabelDescriptionTypeDefault
Path *
PATH
Absolute path to the folder on the server. You can use AJXP_DATA_PATH and AJXP_INSTALL_PATH to point to Pydio default data path and root install path.String
Create *
CREATE
Create folder if it does not existsBooleantrue
File Creation Mask
CHMOD_VALUE
Optionnaly apply a chmod operation. Value must be numeric, like 0777, 0644, etc.String0666
Purge Days (Hard limit)
PURGE_AFTER
Option to purge documents after a given number of days (even if shared). This require a manual set up of a CRON task. Leave to 0 if you don't wan't to use this feature.Integer0
Purge Days (Soft limit)
PURGE_AFTER_SOFT
Option to purge documents after a given number of days (if not shared). This require a manual set up of a CRON task. Leave to 0 if you don't wan't to use this feature.Integer0
Data template
DATA_TEMPLATE
Path to a directory on the filesystem whose content will be copied to the workspace the first time it is loaded.String
Filesystem Commons
Recycle Bin Folder
RECYCLE_BIN
Leave empty if you do not want to use a recycle bin.Stringrecycle_bin
Character Encoding
CHARSET
If your server does not set correctly its charset, it can be good to specify it here manually.String
Pagination Threshold
PAGINATION_THRESHOLD
When a folder will contain more items than this number, display will switch to pagination mode, for better performances.Integer500
#Items per page
PAGINATION_NUMBER
Once in pagination mode, number of items to display per page.Integer200
Remote Sorting
REMOTE_SORTING
Force remote sorting when in paginated mode. Warning, this can impact the performances.Booleantrue
Remote Sorting Default Field *
REMOTE_SORTING_DEFAULT_COLUMN
Default field to sort onSelect (ajxp_label, ajxp_modiftime, filesize, mimestring)ajxp_label
Remote Sorting Default Direction *
REMOTE_SORTING_DEFAULT_DIRECTION
Default sorting directionSelect (asc, desc)asc
Repository Commons
Description
USER_DESCRIPTION
A user-defined description of the content of this workspaceTextarea
Default Rights
DEFAULT_RIGHTS
This right pattern (empty, r, or rw) will be applied at user creation for this workspace.Select (r, rw, w)
Alias
AJXP_SLUG
Alias for replacing the generated unique id of the workspaceString
Group Path
AJXP_GROUP_PATH_PARAMETER
Set this repository group owner : only users of this group will see itString
Disable WebDAV
AJXP_WEBDAV_DISABLED
Explicitly disable WebDAV access for this repository.Booleanfalse
Template Options
Allow to user *
TPL_USER_CAN_CREATE
Allow non-admin users to create a workspace from this template.Booleanfalse
Allow to group admins *
TPL_GRP_ADMINS_CAN_CREATE
Allow group administrators to create a repository from this template.Booleanfalse
Default Label *
TPL_DEFAULT_LABEL
Prefilled label for the new workspace, you can use the AJXP_USER keyworkd in it.String
Small Icon
TPL_ICON_SMALL
16X16 Icon for representing the templateString
Big Icon
TPL_ICON_BIG
Big Icon for representing the templateString