Installation & Configuration
Last updated on
30 April 2025
Drupal 5.x:
- 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.
- Configure the module at admin/settings/webfm. Note: The configuration assumes that the 'File system path:' is set in the usual way at admin/settings/file-system. All WebFM directories are sub-directories of this 'File System' path. Set 'Download method:' radio to 'Public' since the module manages downloads.
- 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 path 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.
- Roles that are granted the 'access webfm' permission will receive 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.
- Roles granted the 'attach WebFM files' permission will be able to see and download attached files. 'Attachment List Properties' sets the presentation of attached files.
- The '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.
- The 'Webfm javascript debug' checkbox 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.
- '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.
- Enable attachments in admin/settings/content-types/*type* for each content type that will accept attachments (default is disabled).
- 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.
Drupal 4.7.x:
- Download the official release from the project page.
- Unzip the archive and copy the 'webfm' directory to your Drupal modules directory. Alternatively copy the tarball to the module directory if you can unzip it on the server.
- Enable the module(s) on Drupal's admin/modules page. Attachment is a separate module in 4.7.x and it has its own settings page. An install file updates the database with the necessary table additions.
- Configure the module. Note: The configuration assumes that the 'File system path' is set in the usual way at admin/settings/file-system. All WebFM directories are relative to this path.
- Manually create the WebFM root and ftp sub-directories inside the directory set at admin/settings/file-system. Set the directory permissions to 775 if the server is linux/bsd.
- In admin/settings/webfm set the root paths (must be prefaced with a '/').
- The icon path 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 'Webfm javascript debug' checkbox is only useful for users interested in looking under the covers or who want to develop the module.
- The 'Forbidden' text box is actually not currently used by the module.
- Set rights in admin/user/access per role. Roles that are granted the 'access webfm' permission will receive additional configuration fields at the bottom of the admin/settings/webfm page. These additional fields are a file extension whitelist, max upload file size and max total upload size. ACCESS CONTROL NOTE: Webfm is an admin module however 'access_webfm' can be selected for the anonymous user. This is NOT recommended since any user that is a member of a role with this right has the ability to make changes to the contents of the filesystem on the server.
- Roles granted the 'attach WebFM files' permission must also enable attachments in /admin/content/types/*type* for each content type that will accept attachments (default is disabled).
- Roles granted the 'see webfm_attachments permission' will be able to see and download attached files. Optionally a .htaccess file (apache servers) can be placed in the WebFM root directory to secure file access via the 'see webfm_attachments' permission.
- Updating the menu cache by navigating to admin/menu may be necessary if upgrading from an earlier version of the module with different internal paths.
Help improve this page
Page status: Not set
You can:
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion