FTP over SSH

All Plugins / Access / Sftp

Identity Card

StatusCore
Plugin LabelFTP over SSH
Short DescriptionAccess a remote server filesystem using FTP via SSH server. Handy for working around permissions problems.
Plugin Identifieraccess.sftp
AuthorCharles du Jeu
Urldocs/references/plugins/access/sftp
Dependenciesaccess.fs

Documentation

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

Ftp connection over SSH, very usefull to have better consistency between Pydio users and real filesystem permissions. Warning, this depend on the libssh2 extension (php_ssh2 on windows).

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
Server URL *
SERV
Path to remote sftp serverString
Port number *
PORT
Port to SSH serverString22
Path *
PATH
Real path to the folder on the serverString
Fix Permissions
FIX_PERMISSIONS
How to handle remote permissions to be used by PHP as local permissions. See manual.Stringdetect_remote_user_id
Create
CREATE
Create folder if it does not existsBooleanfalse
User Credentials
*
USE_AUTH_STREAM
Hiddentrue
User
USER
User name - Can be overriden on a per-user basis (see users 'Personal Data' tab)String
Password
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
USER
User nameString
Password
PASS
User passwordPassword