Documentation /

Getting Started

Installation

System Requirements

You need:

  • WordPress 6.4 or newer
  • Enough storage for your DICOM files (medical images can be large — usually a few MB to hundreds of MB)
  • Standard WordPress hosting — the plugin works with any regular WordPress hosting provider

The plugin doesn’t require any special server setup or external services during normal use.

Installation Methods

Upload via WP-Admin

  1. Download the dicom-viewer.zip plugin archive.
  2. In your WordPress dashboard, navigate to Plugins > Add New.
  3. Click Upload Plugin at the top of the page.
  4. Choose the .zip file and click Install Now.
  5. Once the upload completes, click Activate Plugin.

Manual Upload via FTP / SFTP

  1. Extract the .zip archive on your local machine.
  2. Connect to your server using an FTP or SFTP client.
  3. Upload the extracted dicom-viewer folder to wp-content/plugins/.
  4. In your WordPress dashboard, navigate to Plugins, locate the plugin in the list, and click Activate.

What Happens on Activation

When you activate the plugin:

  • You’ll be taken to the License page to enter your license key
  • The plugin sets itself up to accept DICOM and ZIP files in your media library
  • It’s then ready to use!

License Requirement

The DICOM Viewer requires an active license key to display the viewer. Without a valid license:

  • The Gutenberg block and [dicom_viewer] shortcode are hidden from the editor.
  • File uploads still work, but the viewer will not render on the frontend.
  • All admin settings remain accessible so you can manage the license and configure settings.

See License Activation to enter your key.

Deactivation

When the plugin is deactivated:

  • File uploads via the media library are no longer available for .dcm and .zip files (though files already uploaded remain in the media library).
  • Existing DICOM files remain in the media folder and database — they are not deleted.
  • Plugin settings and license data are preserved in the database.

If you reactivate the plugin later, all your files and settings will be restored.

Next Steps

After activation, proceed to License Activation to enter your license key and activate the plugin.

License Activation

The plugin requires an active license key to display the DICOM Viewer on your site. Without a valid license, the Gutenberg block and shortcode are hidden from the editor, and the viewer will not render on the frontend. Admin settings remain accessible so you can manage your license.

Activating Your License

  1. Navigate to DICOM Viewer > License.
  2. Enter your license key in the License Key field.
  3. Click Activate License.
  4. The plugin contacts the license server at webdevelop.hu to validate the key against your domain.
  5. On success, the license status changes to Active and a confirmation notice is shown.

Tip: You can find your license key in your purchase confirmation email or in your customer account at webdevelop.hu.

Deactivating Your License

To move your license to a different domain:

  1. Navigate to DICOM Viewer > License.
  2. Click Deactivate License.
  3. The plugin sends a deactivation request to the license server, freeing the license for use on another domain.

Important: Always deactivate your license before migrating your site to a new domain. If you are unable to deactivate (e.g., the site is no longer accessible), contact support at webdevelop.hu.

How License Validation Works

Your license is checked periodically to make sure it’s still valid. Here’s what happens:

  • Regular check: Every 24 hours, the plugin checks if your license is still active
  • Grace period: If the license server is temporarily unavailable (like during scheduled maintenance), the plugin continues to work for up to 7 days
  • Expired/revoked licenses: If your license has expired or been revoked, the viewer stops working immediately

What the different statuses mean:

Status What It Means
Active Your license is valid and working. You can use the viewer.
Inactive No license key has been entered yet. Activate a license to use the viewer.
Expired Your license has expired. Renew it to continue using the viewer.
Revoked Your license was cancelled.
Grace Period The license server is temporarily unreachable, but the plugin still works.

Effect of an Invalid License

When the license is not active:

  • The Gutenberg block (dicom-viewer/viewer) does not appear in the block inserter.
  • The [dicom_viewer] shortcode is not processed — the page displays nothing where the shortcode is used.
  • File uploads to the media library still accept .dcm and .zip files, but the viewer will not display them on the frontend.
  • All admin settings remain accessible, allowing you to update your license and configure settings in advance.

Next Steps

With the license activated, proceed to First Steps to upload your first DICOM file and test the viewer.

First Steps

Once you’ve activated your license key, you’re ready to use the plugin. Here’s how to get a DICOM viewer on your site in minutes.

Step 1: Upload a DICOM File

  1. Go to Media > Add New in your WordPress dashboard.
  2. Select a .dcm file or .zip archive containing DICOM files from your computer.
  3. Upload it to the media library.

You’ll see a warning banner about Protected Health Information (PHI). This is a reminder that DICOM files often contain patient data — handle them with care and follow your organization’s privacy policies.

The plugin stores your files securely and doesn’t modify their names or content during upload.

Step 2: Add a Viewer to a Page

Using the Gutenberg Block (Recommended)

  1. Edit or create a WordPress page or post.
  2. Add a new block and search for DICOM Viewer.
  3. Click the block to insert it.
  4. In the sidebar settings, click Select File and choose the DICOM file you just uploaded.
  5. Adjust any display settings if needed (height, series display mode, etc.).
  6. Publish the page.

Using the Shortcode

  1. Edit or create a page and switch to the Code Editor (if using Gutenberg).
  2. Paste this shortcode, replacing 123 with your file’s attachment ID:
[dicom_viewer id="123"]
  1. Publish the page.

You can find your file’s attachment ID in Media > Library — it’s shown in each file’s details.

Step 3: Test the Viewer

  1. Visit the page you just created on the frontend.
  2. You should see the DICOM viewer with:
    • Your medical image displayed in the center
    • Pan, zoom, and window/level controls on the toolbar
    • Series selector (if your file contains multiple series)
    • Play button for cine playback (if multiple slices)

Try clicking the buttons to pan, zoom, and adjust brightness/contrast.

Common Issues

Viewer shows a blank area:

  • Check your license is active at DICOM Viewer > License.
  • Verify the file was uploaded successfully — go to Media > Library and check the file is there.

File won’t upload:

  • Some servers block .dcm files by default. The plugin registers .dcm as a valid MIME type, but your server’s firewall may still block it. Contact your hosting provider if uploads fail.

Questions about your data?

  • See the File Management section for details on how files are stored and protected.

What’s Next?

© 2026 webdevelop.hu — Custom WordPress / WooCommerce Development & Migration Specialist — Contact