Host IronSecureDoc on Mac with C# API

Curtis Chau

Updated: 9 de maio de 2026

Download IronSecureDoc

• DockerHub Download

• ---

• Start Free Trial

Copy for LLMs

• Copy for LLMs

  Copy page as Markdown for LLMs
  # Host IronSecureDoc on Mac with C# API <img src="/img/ironsecuredoc-on-docker.png" alt="IronSecureDoc on Docker" class="img-responsive add-shadow img-margin no-popup" style="max-width:100%;" /> IronSecureDoc é um contêiner Docker projetado para fornecer manipulação avançada de PDFs por meio de uma API REST simples, sem a complexidade e a sobrecarga dos serviços SaaS online. Este guia irá orientá-lo passo a passo na configuração do IronSecureDoc em sua máquina, incluindo a configuração de variáveis ​​de ambiente e um exemplo básico de uso da API REST. Para obter a API completa, consulte nossa [**Referência da API REST**](/enterprise/securedoc/tutorials/use-rest-api/) . ```sh # Pull the latest IronSecureDoc Docker image docker pull ironsoftwareofficial/ironsecuredoc:latest ``` ## Pré-requisitos [[w:(O Docker é compatível com o Docker Desktop nas versões mais recentes do macOS. Ou seja, a versão atual do macOS e as duas versões anteriores. À medida que novas versões principais do macOS são disponibilizadas ao público em geral, o Docker deixa de oferecer suporte à versão mais antiga e passa a oferecer suporte à versão mais recente do macOS (além das duas versões anteriores). )]] **Mac com chip Intel** - [Docker Desktop para Mac com chip Intel](https://docs.docker.com/desktop/install/mac-install/) instalado e em execução **Mac com chip Apple Silicon** - [Docker Desktop para Mac com Apple Silicon](https://docs.docker.com/desktop/install/mac-install/) instalado e em execução ## Guia passo a passo ### 1. Instale o Docker Desktop Se você ainda não instalou o Docker Desktop, siga estes passos: 1. Acesse a [página de download do Docker Desktop](https://www.docker.com/products/docker-desktop) . 2. Baixe o instalador do Docker Desktop para Mac. 3. Execute o instalador e siga as instruções na tela. 4. Após a instalação, inicie o Docker Desktop e verifique se ele está em execução. ### 2. Baixe a imagem Docker "IronSecureDoc". Abra uma interface de linha de comando e baixe a imagem mais recente do IronSecureDoc do Docker Hub: ```sh # Pull the latest IronSecureDoc image docker pull ironsoftwareofficial/ironsecuredoc:latest ``` ### 3. Execute o contêiner sem certificado Execute o contêiner Docker com as variáveis ​​de ambiente necessárias: ```sh # Run the Docker container with environment variables docker container run --rm -p 8080:8080 \ -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> \ -e ENVIRONMENT=Development \ -e HTTP_PORTS=8080 \ ironsoftwareofficial/ironsecuredoc:latest ``` Substitua `<IRONSECUREDOC_LICENSE_KEY>` pela sua chave de licença IronSecureDoc real. Caso contrário, uma marca d'água será aplicada aos recursos corporativos. ### 4. Acesse o contêiner Após a execução do contêiner, você poderá acessar o IronSecureDoc abrindo um navegador da web e navegando até: ```txt http://localhost:8080/swagger/index.html ``` Você deverá ver a interface do IronSecureDoc, indicando que seu contêiner está sendo executado com sucesso. ### 5. Execute o contêiner IronSecureDoc com certificado. Se precisar executar o contêiner com um certificado, siga estas etapas para gerar o certificado e configurar a máquina local: 1. **Gerar certificado** : ```sh # Generate and trust HTTPS development certificate dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER> dotnet dev-certs https --trust ``` Substitua `<CREDENTIAL_PLACEHOLDER>` por uma senha. 2. **Execute o contêiner Docker** : ```sh # Run the container with HTTPS support docker container run -d -p 8081:8081 -p 8080:8080 \ -e HTTP_PORTS=8080 -e HTTPS_PORTS=8081 \ -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> \ -e ENVIRONMENT=Production \ -v $HOME/.aspnet/https:/https:ro \ -e CERTIFICATE_PATH=$HOME/.aspnet/https/ironsecuredoc.pfx \ -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> \ ironsoftwareofficial/ironsecuredoc:latest ``` [[t:( Substitua `<IRONSECUREDOC_LICENSE_KEY>` e `<CERTIFICATE_PASSWORD>` pela sua chave de licença IronSecureDoc real e a senha do certificado, respectivamente. )]] ### 6. Gerenciando o Contêiner Você pode gerenciar seu contêiner em execução usando comandos do Docker. Aqui estão alguns comandos úteis: - **Pare o contêiner** : ```sh docker stop <container_id_or_name> ``` - **Iniciar o contêiner** : ```sh docker start <container_id_or_name> ``` - **Remova o recipiente** : ```sh docker rm -f <container_id_or_name> ``` ## Variáveis ​​de ambiente O contêiner pode ser configurado usando as seguintes variáveis ​​de ambiente: - `PDF_MAX_SIZE_MB` (Padrão: 30): Define o tamanho máximo de arquivo permitido para uploads de PDF em Megabytes. - `REQUEST_TIMEOUT_SECONDS` (Padrão: 5): Define o tempo de espera em segundos para solicitações de API. Um valor de `-1` permite que as solicitações sejam executadas indefinidamente. - `ALLOWED_ORIGINS`: Configura o Compartilhamento de Recursos entre Origens (CORS) especificando URLs de origem permitidos. Separe vários URLs com vírgulas. Use `*` ou `all` para permitir solicitações de qualquer origem. - `HTTP_PORTS`: Define as portas HTTP que o contêiner expõe. Isso deve corresponder ao mapeamento de portas usando o sinalizador `-p` (por exemplo, `8080`). Separe múltiplas portas com um ponto e vírgula (`;`). - `HTTPS_PORTS`: Define as portas HTTPS que o contêiner expõe. Isso deve corresponder ao mapeamento de portas usando o sinalizador `-p` (por exemplo, `8081`). Separe múltiplas portas com um ponto e vírgula (`;`). - `IronSecureDoc_LicenseKey` (Obrigatório): Define a chave de licença IronSecureDoc. Importante: Não compartilhe esse valor publicamente. ## Exemplo básico: Redigir texto em um documento Para obter a lista completa de endpoints da API, consulte a [**Referência completa da API REST**](/enterprise/securedoc/tutorials/use-rest-api/) . ### Redigir texto ```sh # Redact specific words in a PDF document curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf_file=@/path/to/your/document.pdf;type=application/pdf' \ -F 'words_to_redact="sensitiveWord"' \ -F 'draw_black_box=true' \ -F 'match_whole_word=true' \ -F 'match_case=true' ``` Substitua `/path/to/your/document.pdf` pelo caminho real para o documento que você deseja ocultar e `sensitiveWord` pela palavra que você deseja ocultar. ### Redigir expressão regular ```sh # Redact text based on a regular expression in a PDF document curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf_file=@/path/to/your/document.pdf;type=application/pdf' \ -F 'regular_expression="[0-9]"' \ -F 'draw_black_box=true' ``` Substitua `/path/to/your/document.pdf` pelo caminho real para o documento que você deseja ocultar e `[0-9]` pela expressão regular que você deseja corresponder e ocultar. ### Conclusão Você hospedou com sucesso o IronSecureDoc em sua máquina e o configurou com as variáveis ​​de ambiente necessárias. Você também aprendeu como interagir com a API REST do IronSecureDoc usando o cURL para operações básicas e avançadas. Para obter mais detalhes sobre configuração e utilização, consulte a [**Referência completa da API REST**](/enterprise/securedoc/tutorials/use-rest-api/) .

• ---

• Open in ChatGPT

  Ask ChatGPT about this page
• Open in Gemini

  Ask Gemini about this page
• Open in Grok

  Ask Grok about this page
• Open in Perplexity

  Ask Perplexity about this page

Share

• Share on Facebook
• Share on X (Twitter)
• Share on LinkedIn

• ---

• Email article

IronSecureDoc é um contêiner Docker projetado para fornecer manipulação avançada de PDFs por meio de uma API REST simples, sem a complexidade e a sobrecarga dos serviços SaaS online. Este guia irá orientá-lo passo a passo na configuração do IronSecureDoc em sua máquina, incluindo a configuração de variáveis ​​de ambiente e um exemplo básico de uso da API REST. Para obter a API completa, consulte nossa Referência da API REST .

# Pull the latest IronSecureDoc Docker image
docker pull ironsoftwareofficial/ironsecuredoc:latest

# Pull the latest IronSecureDoc Docker image
docker pull ironsoftwareofficial/ironsecuredoc:latest

Pré-requisitos

Mac com chip Intel

• Docker Desktop para Mac com chip Intel instalado e em execução

Mac com chip Apple Silicon

• Docker Desktop para Mac com Apple Silicon instalado e em execução

Guia passo a passo

1. Instale o Docker Desktop

Se você ainda não instalou o Docker Desktop, siga estes passos:

1. Acesse a página de download do Docker Desktop .
2. Baixe o instalador do Docker Desktop para Mac.
3. Execute o instalador e siga as instruções na tela.
4. Após a instalação, inicie o Docker Desktop e verifique se ele está em execução.

2. Baixe a imagem Docker "IronSecureDoc".

Abra uma interface de linha de comando e baixe a imagem mais recente do IronSecureDoc do Docker Hub:

# Pull the latest IronSecureDoc image
docker pull ironsoftwareofficial/ironsecuredoc:latest

# Pull the latest IronSecureDoc image
docker pull ironsoftwareofficial/ironsecuredoc:latest

3. Execute o contêiner sem certificado

Execute o contêiner Docker com as variáveis ​​de ambiente necessárias:

# Run the Docker container with environment variables
docker container run --rm -p 8080:8080 \
  -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> \
  -e ENVIRONMENT=Development \
  -e HTTP_PORTS=8080 \
  ironsoftwareofficial/ironsecuredoc:latest

# Run the Docker container with environment variables
docker container run --rm -p 8080:8080 \
  -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> \
  -e ENVIRONMENT=Development \
  -e HTTP_PORTS=8080 \
  ironsoftwareofficial/ironsecuredoc:latest

Substitua <IRONSECUREDOC_LICENSE_KEY> pela sua chave de licença IronSecureDoc real. Caso contrário, uma marca d'água será aplicada aos recursos corporativos.

4. Acesse o contêiner

Após a execução do contêiner, você poderá acessar o IronSecureDoc abrindo um navegador da web e navegando até:

http://localhost:8080/swagger/index.html

http://localhost:8080/swagger/index.html

Você deverá ver a interface do IronSecureDoc, indicando que seu contêiner está sendo executado com sucesso.

5. Execute o contêiner IronSecureDoc com certificado.

Se precisar executar o contêiner com um certificado, siga estas etapas para gerar o certificado e configurar a máquina local:

1. Gerar certificado :

# Generate and trust HTTPS development certificate
dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust

# Generate and trust HTTPS development certificate
dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust

Substitua <CREDENTIAL_PLACEHOLDER> por uma senha.

2. Execute o contêiner Docker :

# Run the container with HTTPS support
docker container run -d -p 8081:8081 -p 8080:8080 \
  -e HTTP_PORTS=8080 -e HTTPS_PORTS=8081 \
  -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> \
  -e ENVIRONMENT=Production \
  -v $HOME/.aspnet/https:/https:ro \
  -e CERTIFICATE_PATH=$HOME/.aspnet/https/ironsecuredoc.pfx \
  -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> \
  ironsoftwareofficial/ironsecuredoc:latest

# Run the container with HTTPS support
docker container run -d -p 8081:8081 -p 8080:8080 \
  -e HTTP_PORTS=8080 -e HTTPS_PORTS=8081 \
  -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> \
  -e ENVIRONMENT=Production \
  -v $HOME/.aspnet/https:/https:ro \
  -e CERTIFICATE_PATH=$HOME/.aspnet/https/ironsecuredoc.pfx \
  -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> \
  ironsoftwareofficial/ironsecuredoc:latest

6. Gerenciando o Contêiner

Você pode gerenciar seu contêiner em execução usando comandos do Docker. Aqui estão alguns comandos úteis:

• Pare o contêiner :

  docker stop <container_id_or_name>

  SHELL

• Iniciar o contêiner :

  docker start <container_id_or_name>

  SHELL

• Remova o recipiente :

  docker rm -f <container_id_or_name>

  SHELL

Variáveis ​​de ambiente

O contêiner pode ser configurado usando as seguintes variáveis ​​de ambiente:

• PDF_MAX_SIZE_MB (Padrão: 30): Define o tamanho máximo de arquivo permitido para uploads de PDF em Megabytes.
• REQUEST_TIMEOUT_SECONDS (Padrão: 5): Define o tempo de espera em segundos para solicitações de API. Um valor de -1 permite que as solicitações sejam executadas indefinidamente.
• ALLOWED_ORIGINS: Configura o Compartilhamento de Recursos entre Origens (CORS) especificando URLs de origem permitidos. Separe vários URLs com vírgulas. Use * ou all para permitir solicitações de qualquer origem.
• HTTP_PORTS: Define as portas HTTP que o contêiner expõe. Isso deve corresponder ao mapeamento de portas usando o sinalizador -p (por exemplo, 8080). Separe múltiplas portas com um ponto e vírgula (;).
• HTTPS_PORTS: Define as portas HTTPS que o contêiner expõe. Isso deve corresponder ao mapeamento de portas usando o sinalizador -p (por exemplo, 8081). Separe múltiplas portas com um ponto e vírgula (;).
• IronSecureDoc_LicenseKey (Obrigatório): Define a chave de licença IronSecureDoc. Importante: Não compartilhe esse valor publicamente.

Exemplo básico: Redigir texto em um documento

Para obter a lista completa de endpoints da API, consulte a Referência completa da API REST .

Redigir texto

# Redact specific words in a PDF document
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@/path/to/your/document.pdf;type=application/pdf' \
  -F 'words_to_redact="sensitiveWord"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true'

# Redact specific words in a PDF document
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@/path/to/your/document.pdf;type=application/pdf' \
  -F 'words_to_redact="sensitiveWord"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true'

Substitua /path/to/your/document.pdf pelo caminho real para o documento que você deseja ocultar e sensitiveWord pela palavra que você deseja ocultar.

Redigir expressão regular

# Redact text based on a regular expression in a PDF document
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@/path/to/your/document.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true'

# Redact text based on a regular expression in a PDF document
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@/path/to/your/document.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true'

Substitua /path/to/your/document.pdf pelo caminho real para o documento que você deseja ocultar e [0-9] pela expressão regular que você deseja corresponder e ocultar.

Conclusão

Você hospedou com sucesso o IronSecureDoc em sua máquina e o configurou com as variáveis ​​de ambiente necessárias. Você também aprendeu como interagir com a API REST do IronSecureDoc usando o cURL para operações básicas e avançadas. Para obter mais detalhes sobre configuração e utilização, consulte a Referência completa da API REST .

Curtis Chau

Converse agora mesmo com a equipe de engenharia.

Redator Técnico

Curtis Chau é bacharel em Ciência da Computação (Universidade Carleton) e se especializa em desenvolvimento front-end, com experiência em Node.js, TypeScript, JavaScript e React. Apaixonado por criar interfaces de usuário intuitivas e esteticamente agradáveis, Curtis gosta de trabalhar com frameworks modernos e criar manuais bem estruturados e visualmente atraentes.

...

Leia mais