1. Iron Software
  2. IronSecureDoc
  3. Get Started

Get Started

IronSecureDoc on Docker

This guide will help you get IronSecureDoc up and running in 5 minutes. IronSecureDoc will be your air-gapped self-hosted Security Container.

IronSecureDoc can be downloaded as a Docker image from DockerHub.

If you would like a more specific tutorial for your environment, please refer to one of our tutorials:

Hosting IronSecureDoc as a Container

IronSecureDoc will need to run somewhere, giving you full control over how it is accessed and used. Either use your Windows/Mac/Linux machine, a server on your local intranet, or a cloud-hosted container. Whichever suits your needs best.

Host Locally

Deploy to Cloud

Accessing IronSecureDoc as a Client

Once hosted, the IronSecureDoc can be called over RESTful calls to the URL. By default, our documentation covers the REST-API use-case. We also have a .NET Client on NuGet that can be used to abstract the REST API into a client library class, and have plans to launch more of these libraries soon.

Default

.NET Client Library

A Dive into the Product Feature Set

This container contains both free and premium enterprise features. Start a 30-day trial to try out all of the features.

Free and Enterprise Features

Feature Access Table

Feature Specifics

  • Encryption: Add PDF Password + SHA Encryption

    • Set, change, or remove the USER and OWNER passwords.
    • Lock functionality such as: Printing, Copy Text, Fill Forms, etc.
    • Verify the document password is valid and correct.

  • Redaction: Redact words, phrases, RegEx patterns, and regions of a PDF

    • Remove instances of a word throughout the document or on specific pages.
    • Remove patterns using RegEx, such as dates, ID numbers, or names.
    • Remove data from specific regions of PDFs, useful for forms and templates.

  • Certification: Apply a digital signature file (.pfx, .p12) to your PDF document

    • A digital signature assures recipients that the document came from you.
    • Signatures can be set to break when modifications and tampering occur.
    • Verify all the signatures in the document are valid.
  • Extraction: Extract PDF document page text

Installing IronSecureDoc with Docker

Docker images for IronSecureDoc are available from DockerHub. You can use Docker commands to start and stop IronSecureDoc for testing or development.

Pull and Start the container

  1. Install Docker. Visit Get Docker to install Docker for your environment.

    • If using Docker Desktop, make sure to allocate at least 4GB of memory. You can adjust memory usage in Docker Desktop by going to Settings > Resources.

  2. Pull the IronSecureDoc Docker image.

    docker pull ironsoftwareofficial/ironsecuredoc
    docker pull ironsoftwareofficial/ironsecuredoc
    SHELL

  3. Start an IronSecureDoc container.

    Replace your IronSecureDoc license key with the actual license key in the IronSecureDoc_LicenseKey argument. If you do not have one yet, Get a Free Trial License Key today.

    docker run --name ironsecuredoc -p 8080:80 -e IronSecureDoc_LicenseKey=YOUR_LICENSE_KEY ironsoftwareofficial/ironsecuredoc
    docker run --name ironsecuredoc -p 8080:80 -e IronSecureDoc_LicenseKey=YOUR_LICENSE_KEY ironsoftwareofficial/ironsecuredoc
    SHELL

    Tips
    If you have limited memory available on the host, use the -m flag to set a memory limit for the container: -m 2GB

  4. Make a ping-pong REST API call to SecureDoc to ensure the SecureDoc container is running.

    curl http://localhost:8080/v1/document-services/ping
    curl http://localhost:8080/v1/document-services/ping
    SHELL
    • The call should return 200 with the response pong.

Remove containers

To remove the containers, run:

# Remove SecureDoc containers
docker rm ironsecuredoc
# Remove SecureDoc containers
docker rm ironsecuredoc
SHELL