Project

General

Profile

Plugins Directory » Redmine CAD Preview Plugin

Author: Florian Walchshofer
Website: https://github.com/flowalchs/redmine_cad_preview
Code repository: https://github.com/flowalchs/redmine_cad_preview
Registered on: 2026-10-25 (27 days ago)
Current version: 1.4.0
Compatible with: Redmine 7.0.x, 6.1.x, 6.0.x
User ratings:   (0)

Shows CAD attachments directly in Redmine. Instead of "No preview available", the attachment page offers an interactive viewer for issues, documents, files and wiki pages. 3D models can be rotated, zoomed and panned, 2D drawings can be zoomed and panned. The viewer runs entirely in the browser, all libraries are bundled, no internet access or third-party service is needed.

Features

  • 3D preview – rotate, zoom and pan, fit to view, wireframe mode
  • Material and lighting – show 3D models with original or matte materials, and with original or studio lighting (reflections for metallic models); defaults in the plugin settings
  • 2D preview – zoom and pan DXF drawings and DWG drawings (converted to DXF on the server)
  • Measuring – overall dimensions, distance between two points, angle between three points; units taken from the file where available
  • Parts of assemblies – STEP, IGES and BREP assemblies show their parts in a panel: show and hide parts, show only one part; hidden parts are saved with the view
  • Colors – colors of bodies and single faces of STEP models
  • Section view – cut 3D models along the X, Y or Z axis with closed cut faces; saved with the view
  • World axes – XYZ orientation indicator in 3D views, toggled in the toolbar and saved with the view
  • Saved views – save the current view (camera, material, lighting, wireframe) under a name and restore it from the toolbar; a default view is opened first and is used as the thumbnail; a view changed in the meantime gives a conflict instead of being overwritten
  • Images of views – each saved view is stored with a transparent, cropped PNG, which can be downloaded like an attachment
  • Macro – {{cad_preview(model.step, view=front, height=420, readonly)}} shows the viewer in wiki pages, issues, documents and news; view=* shows all saved views, png only the image, readonly hides the controls to save views; suggestions while typing (Redmine 6.1+)
  • PDF export, emails and feeds – the macro shows the image of the view in Redmine's PDF export of issues and wiki pages, in email notifications and in Atom feeds
  • Export – save the current view as PNG or as an A4 PDF including measurement, file name and dimensions
  • Display – maximize the viewer to the browser window or switch to full screen
  • Thumbnails – CAD attachments get thumbnails in attachment lists, like images
  • File icons – own icons for 3D models and drawings (Redmine 7.0+)
  • DWG conversion – runs in the background after upload via LibreDWG (optional)
  • Fast loading of large files – converted DWG files and large text files (STEP, IGES, DXF, OBJ...) are sent gzip-compressed to the browser, without web server configuration (e.g. 22 instead of 210 MB for a large drawing); converted DWG files are also stored compressed
  • Data stays in Redmine – files and images of views are loaded with the same permissions as a normal download
  • API for other plugins – saved views in Ruby and with the REST API, set material and lighting per attachment, save and restore the view in JavaScript, ready and error events

Supported Formats

  • 3D: STEP, IGES, BREP, FreeCAD (FCStd), STL, OBJ, 3MF, glTF/GLB, PLY, Collada, FBX, VRML, AMF, 3DS
  • 2D: DXF, DWG (requires LibreDWG)
  • Embedded preview image only: Autodesk Inventor, Solid Edge, SolidWorks

Permissions

  • Save views of own CAD attachments and Save views of all CAD attachments (section "Project")
  • Viewing and restoring saved views only needs the attachment to be visible

Requirements

  • Redmine 6.0 or higher (6.1 for the macro suggestions, 7.0 for file type icons)
  • Browser with WebGL and WebAssembly support
  • Optional: LibreDWG (dwg2dxf) on the server for DWG preview

Installation

cd $REDMINE_ROOT/plugins
git clone https://github.com/flowalchs/redmine_cad_preview.git
cd $REDMINE_ROOT
bundle exec rake redmine:plugins:migrate NAME=redmine_cad_preview RAILS_ENV=production

Restart Redmine. Configure formats, maximum file size, default material and lighting and the DWG conversion timeout under Administration → Plugins → Redmine CAD Preview → Configure. Give the roles one of the permissions to save views.

The DWG converter is found in the PATH of Redmine. If it is installed elsewhere, set dwg2dxf_command in config/configuration.yml of Redmine, like the commands of ImageMagick and Pandoc.

Project Information

Changelog

1.4.0 (2026-11-19)

Compatible with Redmine 7.0.x, 6.1.x, 6.0.x.

v1.4.0 (2026-11-19)

  • perf: converted DWG files and attachments in text formats (STEP, IGES, DXF, OBJ...) larger than 64 KB are sent gzip-compressed to the browser, which makes the download of large drawings several times smaller (e.g. 22 instead of 210 MB); the compressed copies of the attachments can be turned off in the plugin settings
  • perf: converted DWG files are stored gzip-compressed, which takes much less disk space; files converted by earlier versions are compressed when they are opened
  • feat: the files of the viewer are sent with the content type of the format (e.g. model/step, image/vnd.dxf) instead of application/octet-stream

1.3.0 (2026-11-13)

Compatible with Redmine 7.0.x, 6.1.x, 6.0.x.

v1.3.0 (2026-11-13)

  • feat: the colors of single faces of STEP models are shown, not only the color of the body
  • feat: parts of assemblies (STEP, IGES, BREP) in a panel: show and hide parts, show only one part and fit the view to it; the hidden parts are saved with the view
  • feat: section view of 3D models along the X, Y or Z axis with closed cut faces, moved with a slider or the arrow in the view; the section is saved with the view
  • feat: macro argument readonly for a viewer without the controls to save views
  • feat: world axes in the lower right corner of 3D views, shown by default (plugin setting), toggled in the toolbar and saved with the view, also in the downloads and the images of the views (by Txinto Vaz)
  • fix: fitting the view keeps the model clear of the panel of the parts

1.2.1 (2026-11-06)

Compatible with Redmine 7.0.x, 6.1.x, 6.0.x.

v1.2.1 (2026-11-06)

  • feat: saved views of CAD attachments: save the current view under a name and restore it from the toolbar, for 3D models and 2D drawings
  • feat: the default view is restored when the preview is opened, and its image is the thumbnail of the attachment
  • feat: each view is saved with an image without background, cropped to the model or drawing, which can be downloaded with the attachments API of Redmine
  • feat: permissions to save views of own attachments or of all attachments
  • feat: views in Ruby (`RedmineCadPreview::Views`) and with the REST API, with a conflict instead of overwriting a view changed in the meantime
  • feat: macro `{{cad_preview(attachment, view=name, height=520, png)}}` to show the viewer of an attachment in wiki pages, issues and other texts, with a saved view, all views (`view=*`) or the images of the views
  • feat: the macro shows the images of the views in the PDF export, in emails and in Atom feeds, or the thumbnail of the attachment without default view
  • feat: suggestions for the macro in text fields: the CAD attachments of the issue, wiki page or document, then the options, the saved views of the file and heights; Enter closes the macro, Tab adds the next argument (Redmine 6.1 and later)
  • feat: the image of the view is shown until the viewer is ready, so that a page with viewers looks complete before the files are loaded
  • feat: the list of views shows "Changed view" when the view has been changed, and choosing the view again restores it
  • feat: the downloaded PNG and PDF files get the name of the view if the view has not been changed
  • feat: the buttons of the toolbar are grouped, and the downloads are aligned to the right
  • feat: reverting the migration when the plugin is uninstalled deletes the saved views and the converted DWG files
  • perf: the 3D view is rendered only when it changes, instead of continuously, and the viewers of a page are started one after another, so that pages with several viewers stay responsive
  • perf: DXF and DWG drawings are parsed in a worker, so that large drawings do not block the page and the other viewers
  • perf: STEP, IGES and BREP files are read in a worker
  • perf: large drawings are rendered once when they are loaded or a view is restored, instead of several times, which made the browser report that the page is not responding
  • perf: the WebAssembly file of the STEP, IGES and BREP reader is loaded only once, also if the server does not send it as application/wasm
  • chore: the plugin has a database migration
  • fix: the command of the DWG converter is set in `config/configuration.yml` instead of the plugin settings, so that it cannot be changed in the browser; the settings page shows whether it is available

1.1.0 (2026-10-27)

Compatible with Redmine 7.1.x, 7.0.x, 6.1.x, 6.0.x.

  • Material (original or matte) and lighting (original or studio) for 3D models
  • Studio lighting with reflections, so that metallic models are no longer displayed dark
  • Default material and lighting in the plugin settings
  • API for other plugins: viewer options per attachment, save and restore the view, ready and error events
  • Translations of the new labels in all languages

1.0.0 (2026-10-25)

Compatible with Redmine 7.1.x, 7.0.x, 6.1.x, 6.0.x.