How to Host IronSecureDoc on Windows with C#

This article was translated from English: Does it need improvement?
Translated
View the article in English
IronSecureDoc on Docker

IronSecureDoc은 온라인 SaaS 서비스의 번거로움과 과도한 비용 부담 없이 간단한 REST API를 통해 강력한 PDF 조작 기능을 제공하도록 설계된 Docker 컨테이너입니다. 이 가이드에서는 환경 변수 설정 및 REST API 사용의 기본 예제를 포함하여 IronSecureDoc을 컴퓨터에 호스팅하는 단계를 안내합니다. 전체 API 정보는 REST API 참조를 확인하세요.

docker pull ironsoftwareofficial/ironsecuredoc:latest
docker pull ironsoftwareofficial/ironsecuredoc:latest
SHELL

필수 조건

단계별 가이드

1. Docker Desktop 설치

Docker Desktop을 아직 설치하지 않았다면 다음 단계를 따르세요.

  1. Docker Desktop 다운로드 페이지 로 이동합니다.
  2. Windows용 Docker Desktop 설치 프로그램을 다운로드하세요.
  3. 설치 프로그램을 실행하고 화면의 지시를 따르십시오.
  4. 설치가 완료되면 Docker Desktop을 시작하고 정상적으로 실행 중인지 확인하십시오.

2. "IronSecureDoc" Docker 이미지를 다운로드합니다.

명령 프롬프트를 열고 Docker Hub에서 최신 IronSecureDoc 이미지를 가져오세요.

docker pull ironsoftwareofficial/ironsecuredoc:latest
docker pull ironsoftwareofficial/ironsecuredoc:latest
SHELL

3. 인증서 없이 컨테이너 실행

필요한 환경 변수를 설정하여 Docker 컨테이너를 실행하세요.

Swagger UI in Browser
docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest
docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest
SHELL

워터마크를 제거하려면 체험판 또는 라이선스 키를 적용하세요.

Replace <IRONSECUREDOC_LICENSE_KEY> 를 실제 IronSecureDoc 라이선스 키로 교체하십시오. 그렇지 않으면 Enterprise 기능에 워터마크가 적용됩니다.

Swagger UI in Browser

4. 컨테이너에 접근하기

컨테이너가 실행되면 웹 브라우저를 열고 다음 주소로 이동하여 IronSecureDoc에 액세스할 수 있습니다.

http://localhost:8080/swagger/index.html
Swagger UI in Browser

컨테이너가 성공적으로 실행 중임을 나타내는 IronSecureDoc 인터페이스가 표시될 것입니다.

5. 인증서를 사용하여 IronSecureDoc 컨테이너를 실행합니다.

컨테이너를 인증서와 함께 실행해야 하는 경우, 다음 단계를 따라 인증서를 생성하고 로컬 머신을 구성하십시오.

  1. 인증서 생성 :

    dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
    dotnet dev-certs https --trust
    dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
    dotnet dev-certs https --trust
    SHELL

    <CREDENTIAL_PLACEHOLDER> 를 비밀번호로 교체하십시오.

  2. Docker 컨테이너 실행 :

    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 %USERPROFILE%\.aspnet\https:/https:ro -e CERTIFICATE_PATH=%USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> ironsoftwareofficial/ironsecuredoc:latest
    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 %USERPROFILE%\.aspnet\https:/https:ro -e CERTIFICATE_PATH=%USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> ironsoftwareofficial/ironsecuredoc:latest
    SHELL

    <IRONSECUREDOC_LICENSE_KEY><CERTIFICATE_PASSWORD> 를 각각 실제 IronSecureDoc 라이선스 키와 인증서 비밀번호로 교체하십시오.

6. 컨테이너 관리

Docker 명령어를 사용하여 실행 중인 컨테이너를 관리할 수 있습니다. 다음은 몇 가지 유용한 명령어입니다.

  • 컨테이너를 중지합니다 .

    docker stop <container-id>
    docker stop <container-id>
    SHELL
  • 컨테이너를 시작합니다 .

    docker start <container-id>
    docker start <container-id>
    SHELL
  • 용기를 제거하세요 :

    docker rm -f <container-id>
    docker rm -f <container-id>
    SHELL

<container-id> 를 실제 컨테이너 ID 또는 이름으로 교체하십시오.

환경 변수

컨테이너는 다음 환경 변수를 사용하여 구성할 수 있습니다.

  • PDF_MAX_SIZE_MB (기본값: 30): PDF 업로드의 최대 허용 파일 크기를 메가바이트로 설정합니다.
  • REQUEST_TIMEOUT_SECONDS (기본값: 5): API 요청에 대한 타임아웃 시간을 초 단위로 설정합니다. -1 의 값은 요청을 무기한으로 실행할 수 있게 합니다.
  • ALLOWED_ORIGINS: 허용된 출처 URL을 지정하여 교차 출처 리소스 공유(CORS)를 구성합니다. 여러 개의 URL을 쉼표로 구분하세요. * 또는 all 을 사용하여 모든 출처로부터의 요청을 허용합니다.
  • HTTP_PORTS: 컨테이너가 노출하는 HTTP 포트를 정의합니다. 이것은 -p 플래그를 사용한 포트 매핑과 일치해야 합니다 (예: 8080). 여러 포트는 세미콜론으로 구분하십시오 (;).
  • HTTPS_PORTS: 컨테이너가 노출하는 HTTPS 포트를 정의합니다. 이것은 -p 플래그를 사용한 포트 매핑과 일치해야 합니다 (예: 8081). 여러 포트는 세미콜론으로 구분하십시오 (;).
  • IronSecureDoc_LicenseKey (필수): IronSecureDoc 라이선스 키를 설정합니다. 중요: 이 값을 공개적으로 공유하지 마십시오.

기본 예시: 문서에서 텍스트 삭제

전체 API 엔드포인트 목록은 전체 REST API 참조를 참조하십시오.

텍스트 수정

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'
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'
SHELL

/path/to/your/document.pdf 를 교체하고자 하는 문서의 실제 경로로 교체하고 sensitiveWord 를 교체하고자 하는 단어로 교체하십시오.

정규 표현식 수정

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'
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'
SHELL

/path/to/your/document.pdf 를 교체하고자 하는 문서의 실제 경로로 교체하고 [0-9] 를 일치하고 교체하고자 하는 정규 표현식으로 교체하십시오.

결론

IronSecureDoc을 컴퓨터에 성공적으로 설치하고 필요한 환경 변수를 설정했습니다. 또한 cURL을 사용하여 기본 및 고급 작업을 통해 IronSecureDoc REST API와 상호 작용하는 방법을 배웠습니다. 자세한 구성 및 사용 정보는 전체 REST API 참조 문서를 참조하십시오.

자주 묻는 질문

IronSecureDoc이란 무엇인가요?

IronSecureDoc는 오프라인 문서 보안 및 준수를 위해 설계된 간단한 REST API를 통해 강력한 PDF 조작을 제공하는 Docker 컨테이너입니다.

Windows에서 IronSecureDoc를 호스팅하기 위한 시스템 요구 사항은 무엇입니까?

Windows에서 IronSecureDoc를 호스팅하려면 Windows 10 이상, 또는 Windows Server 버전(2016, 2019, 2022) 및 Windows 용 Docker Desktop이 설치되어 있어야 합니다.

내 Windows 장치에 Docker Desktop을 어떻게 설치할 수 있습니까?

공식 Docker 웹사이트에서 Docker Desktop을 다운로드하고 설치 프로그램을 실행하여 설치 지침을 따릅니다. 설치 후 Docker Desktop을 시작하여 사용을 시작합니다.

IronSecureDoc Docker 이미지를 어떻게 다운로드합니까?

명령 프롬프트를 열고 실행합니다: docker pull ironsoftwareofficial/ironsecuredoc:latest IronSecureDoc 이미지를 다운로드합니다.

SSL 인증서 없이 IronSecureDoc를 실행할 수 있습니까?

예, SSL 인증서 없이 IronSecureDoc 컨테이너를 'docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=-e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest' 명령을 실행하여 실행할 수 있습니다.를 실제 라이센스 키로 교체합니다.

컨테이너가 실행된 후 IronSecureDoc 인터페이스에 어떻게 액세스할 수 있습니까?

http://localhost:8080/swagger/index.html로 이동하여 웹 브라우저를 열어 IronSecureDoc 인터페이스에 액세스할 수 있습니다.

SSL 인증서로 IronSecureDoc를 어떻게 구성합니까?

dotnet dev-certs를 사용하여 인증서를 생성한 다음 인증서 경로와 암호가 포함된 명령으로 IronSecureDoc 컨테이너를 실행하여 보안을 강화합니다.

IronSecureDoc 컨테이너를 구성하는데 사용 가능한 환경 변수는 무엇입니까?

여러 환경 변수를 구성할 수 있습니다: PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS, IronSecureDoc_LicenseKey.

IronSecureDoc를 사용하여 PDF에서 민감한 정보를 어떻게 수정할 수 있습니까?

PDF에서 텍스트를 수정하려면 cURL 명령을 사용하여 IronSecureDoc REST API에 POST 요청을 보내 PDF 파일과 수정할 텍스트 또는 패턴을 지정하십시오.

IronSecureDoc REST API에 대한 자세한 문서를 어디에서 찾을 수 있습니까?

IronSecureDoc에 대한 전체 REST API 참조는 /enterprise/securedoc/tutorials/use-rest-api/에 있습니다.

커티스 차우
기술 문서 작성자

커티스 차우는 칼턴 대학교에서 컴퓨터 과학 학사 학위를 취득했으며, Node.js, TypeScript, JavaScript, React를 전문으로 하는 프론트엔드 개발자입니다. 직관적이고 미적으로 뛰어난 사용자 인터페이스를 만드는 데 열정을 가진 그는 최신 프레임워크를 활용하고, 잘 구성되고 시각적으로 매력적인 매뉴얼을 제작하는 것을 즐깁니다.

커티스는 개발 분야 외에도 사물 인터넷(IoT)에 깊은 관심을 가지고 있으며, 하드웨어와 소프트웨어를 통합하는 혁신적인 방법을 연구합니다. 여가 시간에는 게임을 즐기거나 디스코드 봇을 만들면서 기술에 대한 애정과 창의성을 결합합니다.

시작할 준비 되셨나요?
버전: 2024.10 방금 출시되었습니다
Still Scrolling Icon

아직도 스크롤하고 계신가요?

빠른 증거를 원하시나요?
샘플 실행 PDF가 암호화되는 것을 확인하세요.