Version 9.6 by Sergiu Dumitriu on 2012/05/17

Attachments can be uploaded either through the regular upload action, WebDAV, XMLRPC or Rest.
As an administrator you can set limits on the maximum size of an attachment and where the attachments will be stored.

Size Limit

The maximum size of an attachment is limited by a configuration parameter in XWikiPreferences document. It is set to about 10MB by default.
To change it:

  1. Go to <yourwiki>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object
    2. Click on the line that says XWikiPreferences 0 (right below the line that says Objects of type XWiki.XWikiPreferences (1))
    3. Scroll down to the field that says Maximum Upload Size and change the number to whatever size you want (it is expressed in bytes)
    4. Scroll to the bottom and click save.


When a user uploads an attachment then uploads another attachment with the exact same name, you can decide whether or not to keep a version history of the attachments like you do with documents.
XWiki stores all document attachment versions by default which costs more storage space. If you need only latest versions of attachments, you can disable attachment version control by editing your xwiki.cfg and adding:


Deleted attachments are stored in a recycle bin so that they can be restored along with the document when rolling back or previewing an earlier version where the attachment should be visible. To disable this feature, edit xwiki.cfg and add:


You can view the list of deleted attachments in your wiki and delete them permanently by going to XWiki.DeletedAttachments in your wiki.

Attachment Storage

XWiki offers plugin attachment storage mechanisms so you can store your attachments in the database or directly in the filesystem.

No matter what type of attachment store you use, the meta-data for the attachment will be saved in the xwikiattachment table for faster loads.

Database Attachment Store (Default)

This attachment storage mechanism stores your attachments in database entries in the xwikiattachment_content, xwikiattachment_archive, and xwikiattrecyclebin tables. This system allows for easy backup of your attachments by dumping the database and keeps all of your data together but attachment size is memory constrained since the attachment content and archive must all be held in memory. As a general rule, attachments larger than 30MB are not possible.
Note: When using this attachment store with a MySQL database, you must set the max_allowed_packet to about 3 times the size of your largest attachment since the attachment and it's version history must be saved. See InstallationMySQL for more information.

Filesystem Attachment Store (Since XWiki Enterprise 3.0M2)

The Filesystem Attachment Store is still in beta, it has passed all of our tests with flying colors but we need your help to make absolutely sure that everything is right before turning it on by default.

The Filesystem attachment store saves your attachments in files in a directory tree, this means you will have one more thing to do when you back up your data but it also means you can save larger (over one gigabyte) files. Filesystem attachment store implements a two stage commit mechanism to maintain integrity even if the database fails to commit the attachment meta-data.

Filesystem attachment store location

The directory in which the attachments are stored in the filesystem is defined with the parameter environment.permanentDirectory in the file. By default it's defined to be data, which is a directory relative to where the Java Servlet Container was started. It's recommend to modify this value to be absolute so that you can start the Servlet Container from any directory and still have XWiki find the attachments located in this work directory.

For example:


Directory Structure


The Filesystem Attachment Store puts your attachments into a directory tree on the hard disk, the directory structure is designed to be intuitive to navigate but you should never add or remove anything. Each attachment is accompanied by a piece of meta-data in the database and modifying the content in the filesystem store manually will lead to meta-data with no content or content with no meta-data.

New users

If you are a new XWiki user, all you need to do for enabling Filesystem Attachment Store is to change some settings in the xwiki.cfg file.
These settings should read as follows: = file = file = file

Also make sure they are not commented out.

Users who already have a running wiki

If you already have a wiki and want to take advantage of the Filesystem Attachment Store, you should use the Filesystem Attachment Porter to move your existing attachments onto the filesystem.

Other considerations

  • If you are running a cluster you will need for each node to have a synchronized storage directory, you can use NFS or another means to mount the disk on each node in the cluster.

Get Connected