Host IronSecureDoc on Mac with C# API

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

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

   SHELL

   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

   SHELL
   PontasSubstitua <IRONSECUREDOC_LICENSE_KEY> e <CERTIFICATE_PASSWORD> pela sua chave de licença IronSecureDoc real e 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 :

  docker stop <container_id_or_name>

  docker stop <container_id_or_name>

  SHELL

• Iniciar o contêiner :

  docker start <container_id_or_name>

  docker start <container_id_or_name>

  SHELL

• Remova o recipiente :

  docker rm -f <container_id_or_name>

  docker rm -f <container_id_or_name>

  SHELL

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 redigir e sensitiveWord pela palavra que você deseja redigir.

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 redigir e [0-9] pela expressão regular que você deseja corresponder e redigir.

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 .