Documents

Upload, categorise, and browse project documents in Redmine.

The Documents module provides a simple document repository for each project. Documents are organised into administrator-defined categories and can have multiple file attachments.

Enabling documents

1. Go to Project → Settings → Modules.
2. Check Documents.
3. Click Save.

A Documents link appears in the project sidebar.

Document categories

Documents are grouped by category. Categories are defined globally under Administration → Enumerations → Document categories. Common categories include:

• User documentation
• Technical documentation
• Specifications

Every document must belong to a category. If no custom categories are configured, a default category is used.

Creating a document

1. Open the documents list

   Click Documents in the project sidebar.

2. Add a document

   Click New document.

3. Fill in the document fields

   • Title — required display name for the document (maximum 255 characters)
   • Category — required; select from the available document categories
   • Description — optional text describing the document content. Supports Redmine text formatting.
4. Attach files

   Use the Files section to upload one or more files. A document can have multiple attachments. The updated_on field reflects the date of the most recent attachment.

5. Save

   Click Create. Project members receive a notification if the Document added event is enabled.

Adding files to an existing document

1. Open the document.
2. Click Add in the Files section.
3. Select the files to upload and click Save.

You can add multiple files to a single document to group related attachments (for example, different versions of a specification).

Browsing documents

The documents list shows all documents for the project, grouped by category. You can:

• Sort by Title or Date.
• Click a document title to view its description and download its attachments.
• Use the category headings to jump to a specific section.

Custom fields for documents

Administrators can define custom fields of type Document under Administration → Custom fields. When enabled for a project, these fields appear on the document creation and edit forms.

Editing and deleting documents

• Edit — Click the edit icon on the document to update the title, category, description, or attachments. Requires the edit_documents permission.
• Delete — Click the delete icon to remove the document and all its attachments. Requires the delete_documents permission.
• Delete attachment — Individual attachments can be removed from the document detail page. Requires the delete_documents permission.

Notifications

Email notifications are sent when a document is added if the Document added event is enabled in Administration → Settings → Email notifications.

Permissions

Action	Permission required
View documents	view_documents
Manage documents (create, edit)	manage_documents
Delete documents	delete_documents