FTP Server

All Plugins / Access / Ftp

Identity Card

StatusCore
Plugin LabelFTP Server
Short DescriptionThis driver can access a remote FTP server
Plugin Identifieraccess.ftp
AuthorCharles du Jeu
Urldocs/references/plugins/access/ftp
Dependenciesaccess.fs

Documentation

Disclaimer: If you installed Pydio by the linux repository ( apt / yum ), you must install the "pydio-plugin-access.ftp" package.

Use Pydio server as proxy to a remote FTP server. If the filesystem you want to browse is not locally accessible by the server and you can access it via FTP, use this driver for browsing the data. The user/password used to authenticate against the FTP server can be set in various ways, either using one credential for all users, or setting each users credentials, or even using the ftp server as the credential provider.

The plugin can be linked to the auth.ftp to transform Pydio into a fully-feature generic FTP client, allowing your users to log in to any ftp server they want. See auth.ftp for more info.

If you have enough accesses, you should also consider the plugin access.sftp, that uses SSH access to browse a server. It can be an interesting solution when you are struggling with permissions problems.

Plugin parameters

LabelDescriptionTypeDefault
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.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
Connection
Host *
FTP_HOST
Ftp Host to connect toString
Port *
FTP_PORT
Ftp Host portString21
Path *
PATH
Real path to the root folder on the serverString/
Secure *
FTP_SECURE
Whether to use ftp or ftps protocolBooleanfalse
Active *
FTP_DIRECT
Whether to use active or passiveBooleanfalse
Test Connection
TEST_CONNEXION
Test FTP connectionButton
FTP Server Tweaks
Create
CREATE
Create folder if it does not existsBooleanfalse
User Id *
UID
To fetch the user id you have to run a listing command on your ftp client (ls or dir most of the time) and take the first of the two last numbers as the user id. It can be possible that there is more than one number. If you experience errors using one id try to use another one.String
Fix Permissions
FIX_PERMISSIONS
How to handle remote permissions to be used by PHP as local permissions. See manual.Select (detect_remote_user_id, user, group)detect_remote_user_id
Temporary Folder *
TMP_UPLOAD
Temporary folder on the local server used for file uploads. For the moment, it must be placed under your ajaxplorer folder and you must create it and set it writeable by Apache.String/tmp
Dynamic FTP
Pass Ftp data through Auth driver
DYNAMIC_FTP
In conjunction with a correctly configured auth.ftp driver, this allow to transform ajaxplorer into a simple netFtp client.Booleanfalse
User Credentials
*
USE_AUTH_STREAM
Hiddentrue
User
FTP_USER
User name - Can be overriden on a per-user basis (see users 'Personal Data' tab)String
Password
FTP_PASS
User password - Can be overriden on a per-user basis.Password
Session credentials
USE_SESSION_CREDENTIALS
Try to use the current Pydio user credentials for connecting. Warning, the AJXP_SESSION_SET_CREDENTIALS config must be set to true!Booleanfalse
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

User-specific

LabelDescriptionTypeDefault
User
FTP_USER
User nameString
Password
FTP_PASS
User passwordPassword