Last updated February 15, 2009. Created by robmilne on February 15, 2009.
Log in to edit this page.

  • Download the official release from the project page.
  • Unzip the archive and copy the 'webfm' directory to your modules directory (ie:/sites/all/modules). Alternatively copy the tarball to the module directory if you can unzip it on the server.
  • Enable the module on Drupal's admin/build/modules page. An install file updates the database with the necessary table additions.
  • Set the 'File system path:' at .../admin/settings/file-system. The WebFM root directory is always a sub-directory of this 'File System' path. 'Download method:' has no effect on the module since WebFM implements its own download security.
  • Configure the module at .../admin/settings/webfm.
    • Create the 'WebFM root directory'. If this directory doesn't already exist, the system will create it in the File System root. Multi directory root paths must already exist inside the 'File System' directory. Set the directory permissions to 775 if the server is linux/bsd.
    • The 'Icon directory' allows the user to substitute their own gifs. File names are hardcoded in the javascript so the icons will have to have identical names.
    • The 'Maximum resolution for uploaded images' input functions in the same fashion as the root upload.module.
    • The 'Date Format' radio buttons set the day/month order in the browser listing date field.
    • The 'Display metadata title' checkbox sets the browser to display metadata titles rather than the actual filename if the metadata title exists. Renaming files that use the metadata title must be done via the metadata editor. Note that node attachments always display the metadata title if available.
    • Default File Permissions set the file level permissions for files inserted into the database. The exception is file uploads that create a version overwrite whereby the new file inherits the permissions from the previous file.
    • Settings for xxx role fieldsets are added for roles that are granted the 'access webfm' permission. Each role receives additional configuration fields for root path, extension white list, max upload file size and max total upload size. Roles with the 'access webfm' right but without a root directory cannot access the filesystem.
    • WebFM attachments controls attachment of files to node content as well as format.
      Note: Each content type that will be using WebFM attachments must enable attachments in the Workflow section of admin/settings/content-types/*type* (default is 'WebFM attachments' disabled).
    • IE Drag-and-Drop Normalization is a sub-optimal solution for compensating for relative positioning in theme css. This feature is only available to #1 user.
    • WebFM debug contains a 'Webfm javascript debug' checkbox which is only useful for users interested in looking under the covers or who want to develop the module. The 'WebFM cron' is a 'stored procedure' used for database cleanup of file records that are deleted outside of the WebFM interface (ie: OS shell, ftp). This feature is only available to #1 user.
  • Set WebFM rights in admin/user/access per role.
    • administer webfm confers full rights to a role. Admins can see and operate on all files, including files not in the database. Only admins can create directories and access admin/settings/webfm.
    • access webfm allows a role to download/view files via the WebFM browser. Only files referenced by the webfm_file table in the database are accessible. Only owners of a file (and admins) can move a file or modify it's metadata.
      Note: Each role granted 'access webfm' will receive a separate fieldset in the module settings where a root directory must be created to permit access to the browser.
    • view webfm attachments allows a role to see files attached to nodes via WebFM.
    • webfm upload allows a role with the 'access webfm' right to upload files via the WebFM browser. The user who uploads a file is the the owner of that file.
  • Admins and File owners can set the following file level permissions from the context menu of each file:
    • Public download: Allows the file to be downloaded anonymously even if .htaccess exists.
    • Role View/Download: Allows users of the same role to view/download the file.
    • Role Attach: Allows users of the same role to attach the file to nodes.
    • Role Full Access: Allows users of the same role to have the same rights to the file as the owner with the exception of permission edits.
  • A .htaccess file (apache servers) can be placed in the WebFM root (or sub-path) to secure file access. Webfm streams downloads and thus your browser doesn't require direct http access to the directories
  • Updating the menu cache by navigating to .../admin/build/menu may be necessary if upgrading from an earlier version of the module with different internal paths.
  • Translations of the module require revising the string array at the top of webfm.js.

Looking for support? Visit the Drupal.org forums, or join #drupal-support in IRC.