Samba via libsbmclient

All Plugins / Access / Smbicewind

Identity Card

StatusCore
Plugin LabelSamba via libsbmclient
Short DescriptionBrowse a Samba Server
Plugin Identifieraccess.smbicewind
AuthorCharles du Jeu
Urldocs/references/plugins/access/smbicewind
Dependenciesaccess.fs

Documentation

Connect a Samba share and browse its files and folders. This plugin is based on a php wrapper around the command line tool smbclient.

There are two possible modes for this plugin:

  • 1/ Direct access to libsmbclient: this library must be installed on the machine, and PHP must be compiled with php-libsmbclient extension.
  • 2/ Wrapping the smbclient binary via command line
The first case is not tested on Windows. The plugin should automatically detect which mode to use, by guessing if libsmbclient functions are available in PHP.

The smbclient tool must be installed on the server and accessible in the machine path. If you want to manually set the path to the smbclient program, edit the plugin global configuration. Interestingly, there is a working alternative of smbclient installable on Windows, using Cygwin. See the detailed instructions here. But for a better result please use smbclient 3.0.23c here. In that case, you may have to enter the full path to the smbclient via the plugin configuration.

For a repository, a typical configuration can be

  • Host : 192.168.0.25
  • Uri : Share
If you encounter problems with "empty listing", check the server logs, and particularly set the server into debug mode : errors grabbed from the smbclient output are logged to the log file, not to the GUI, as sometimes it contains errors but sometimes it contains just warning or even info.

Like the ftp access driver with the auth.ftp, this smb driver can be used in conjunction with the auth.smb plugin to authenticate users directly against the samba share.

The SMB wrapper was first developped by Victor M. Varela.

Plugin parameters

LabelDescriptionTypeDefault
Smbclient *
SMBCLIENT
Path to smbclient executable, considered to be in the path by default.Stringsmbclient
Enable Zip
SMB_ENABLE_ZIP
Enable zip creation for repositories using Samba access. Make sure that you are using a very fast network, otherwise it will be very long!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.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
Host *
HOST
Server IP or name, do not use add slashes or backward slashesStringSERVER_IP
Uri
PATH
Path to the share and complementary URI if necessaryString
Domain
DOMAIN
Default domain to use with session credentials. The domain name ends with '/' or '\' depend on your system. Example: MyDomain\ or YourDomain/. Default is /String
File Creation Mask
CHMOD_VALUE
Optionnaly apply a chmod operation. Value must be numeric, like 0777, 0644, etc.String0666
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