로컬 Dispatcher 도구 설정

마지막 업데이트: 2024-01-25
  • 작성 대상:
  • Beginner
    Developer

Adobe Experience Manager(AEM)의 Dispatcher는 CDN과 AEM Publish 계층 간에 보안 및 성능 계층을 제공하는 Apache HTTP 웹 서버 모듈입니다. Dispatcher는 전체 Experience Manager 아키텍처의 필수적인 부분이며 로컬 개발 설정의 일부여야 합니다.

AEM as a Cloud Service SDK에는 Dispatcher를 로컬에서 구성 및 시뮬레이션을 용이하게 하는 권장 Dispatcher 도구 버전이 포함되어 있습니다. Dispatcher 도구는 다음과 같이 구성됩니다.

  • 다음 위치에 있는 Apache HTTP 웹 서버 및 Dispatcher 구성 파일의 기본 세트 .../dispatcher-sdk-x.x.x/src
  • 다음 위치에 있는 구성 유효성 검사기 CLI 도구 .../dispatcher-sdk-x.x.x/bin/validate
  • 다음 위치에 있는 구성 생성 CLI 툴 .../dispatcher-sdk-x.x.x/bin/validator
  • 다음 위치에 있는 구성 배포 CLI 도구 .../dispatcher-sdk-x.x.x/bin/docker_run
  • 다음 위치에 있는 CLI 도구를 덮어쓰는 변경할 수 없는 구성 파일 .../dispatcher-sdk-x.x.x/bin/update_maven
  • Dispatcher 모듈로 Apache HTTP 웹 서버를 실행하는 도커 이미지

참고: ~ 는 사용자 디렉토리의 축약으로 사용됩니다. Windows에서 이는 %HOMEPATH%.

노트

이 페이지의 비디오는 macOS에 기록되었습니다. Windows 사용자는 따를 수 있지만 각 비디오와 함께 제공되는 동등한 Dispatcher 도구 Windows 명령을 사용합니다.

사전 요구 사항

  1. Windows 사용자는 Windows 10 Professional(또는 Docker를 지원하는 버전)을 사용해야 합니다
  2. 설치 Experience Manager 게시 Quickstart Jar 로컬 개발 시스템에서 사용할 수 있습니다.
  • 필요한 경우 최신 버전을 설치합니다. AEM 참조 웹 사이트 로컬 AEM Publish 서비스에서. 이 웹 사이트는 이 자습서에서 작동하는 Dispatcher를 시각화하는 데 사용됩니다.
  1. 최신 버전의 설치 및 시작 도커 로컬 개발 컴퓨터의 (Docker Desktop 2.2.0.5+ / Docker Engine v19.03.9+).

AEM SDK의 일부로 Dispatcher 도구 다운로드

AEM as a Cloud Service SDK 또는 AEM SDK에는 개발을 위해 로컬에서 Dispatcher 모듈을 사용하여 Apache HTTP 웹 서버를 실행하는 데 사용되는 Dispatcher 도구와 호환되는 QuickStart Jar가 포함되어 있습니다.

AEM as a Cloud Service SDK가에 이미 다운로드한 경우 로컬 AEM 런타임 설정, 다시 다운로드할 필요는 없습니다.

  1. 에 로그인 experience.adobe.com/#/downloads Adobe ID 사용
    • Adobe 조직 필수 AEM as a Cloud Service으로 프로비저닝하여 AEM as a Cloud Service SDK 다운로드
  2. 최신 항목을 클릭합니다. AEM SDK 다운로드할 결과 행

AEM SDK zip에서 Dispatcher 도구 추출

Windows 사용자는 로컬 Dispatcher 도구가 포함된 폴더의 경로에 공백이나 특수 문자를 사용할 수 없습니다. 경로에 공백이 있으면 docker_run.cmd 실패.

Dispatcher 도구 버전은 AEM SDK의 버전과 다릅니다. Dispatcher 도구 버전이 AEM as a Cloud Service 버전과 일치하는 AEM SDK 버전을 통해 제공되는지 확인하십시오.

  1. 다운로드한 파일 압축 풀기 aem-sdk-xxx.zip 파일
  2. Dispatcher 도구 압축을 풉니다. ~/aem-sdk/dispatcher
$ chmod a+x aem-sdk-dispatcher-tools-x.x.x-unix.sh
$ ./aem-sdk-dispatcher-tools-x.x.x-unix.sh

압축 풀기 aem-sdk-dispatcher-tools-x.x.x-windows.zip 대상 C:\Users\<My User>\aem-sdk\dispatcher (필요에 따라 누락된 폴더를 만듭니다.)

$ chmod a+x aem-sdk-dispatcher-tools-x.x.x-unix.sh
$ ./aem-sdk-dispatcher-tools-x.x.x-unix.sh

아래에 실행된 모든 명령은 현재 작업 디렉터리에 확장 중인 Dispatcher 도구 콘텐츠가 포함되어 있다고 가정합니다.

이 비디오는 설명 목적으로 macOS을 사용합니다. 동일한 Windows/Linux 명령을 사용하여 유사한 결과를 얻을 수 있습니다.

Dispatcher 구성 파일 이해

Experience Manager 프로젝트를에서 만들었습니다. AEM Project Maven Archetype 는 이 Dispatcher 구성 파일 세트를 미리 채우므로 Dispatcher 도구 src 폴더에서 복사할 필요가 없습니다.

Dispatcher 도구는 로컬 개발을 포함하여 모든 환경에 대한 동작을 정의하는 Apache HTTP 웹 서버 및 Dispatcher 구성 파일 세트를 제공합니다.

이러한 파일은 Experience Manager Maven 프로젝트에 dispatcher/src 폴더가 없는 경우 Experience Manager Maven 프로젝트에 있어야 합니다.

구성 파일에 대한 전체 설명은 압축을 푼 Dispatcher 도구에서 다음과 같이 사용할 수 있습니다. dispatcher-sdk-x.x.x/docs/Config.html.

구성 유효성 검사

선택적으로 Dispatcher 및 Apache 웹 서버 구성(다음을 통해) httpd -t)은 다음을 사용하여 확인할 수 있습니다. validate 스크립트(와 혼동하지 않음) validator 실행 파일). 다음 validate 스크립트는 단계 / validator.

$ ./bin/validate.sh ./src
$ bin\validate src
$ ./bin/validate.sh ./src

로컬에서 Dispatcher 실행

AEM Dispatcher는 다음에 대해 도커를 사용하여 로컬에서 실행됩니다. src Dispatcher 및 Apache 웹 서버 구성 파일입니다.

$ ./bin/docker_run_hot_reload.sh <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>

다음 docker_run_hot_reload 실행 파일이 우선합니다. docker_run 구성 파일이 변경될 때 수동으로 종료했다가 다시 시작하지 않아도 구성 파일이 다시 로드됨 docker_run. 또는 docker_run 를 사용할 수 있지만 수동으로 종료했다가 다시 시작해야 합니다. docker_run 구성 파일이 변경되는 경우.

$ bin\docker_run <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>
$ ./bin/docker_run_hot_reload.sh <src-folder> <aem-publish-host>:<aem-publish-port> <dispatcher-port>

다음 docker_run_hot_reload 실행 파일이 우선합니다. docker_run 구성 파일이 변경될 때 수동으로 종료했다가 다시 시작하지 않아도 구성 파일이 다시 로드됨 docker_run. 또는 docker_run 를 사용할 수 있지만 수동으로 종료했다가 다시 시작해야 합니다. docker_run 구성 파일이 변경되는 경우.

다음 <aem-publish-host> 을 로 설정할 수 있습니다. host.docker.internal를 사용하는 경우 특별한 DNS 이름 Docker는 호스트 시스템의 IP로 확인되는 컨테이너를 제공합니다. 다음과 같은 경우 host.docker.internal 해결되지 않습니다. 다음을 참조하십시오. 문제 해결 아래 섹션.

예를 들어 Dispatcher 도구에서 제공하는 기본 구성 파일을 사용하여 Dispatcher 도커 컨테이너를 시작하려면 다음을 수행하십시오.

Dispatcher 구성 src 폴더의 경로를 제공하는 Dispatcher Docker 컨테이너를 시작합니다.

$ ./bin/docker_run_hot_reload.sh ./src host.docker.internal:4503 8080
$ bin\docker_run src host.docker.internal:4503 8080
$ ./bin/docker_run_hot_reload.sh ./src host.docker.internal:4503 8080

포트 4503에서 로컬로 실행되는 AEM as a Cloud Service SDK의 게시 서비스는 다음 Dispatcher를 통해 사용할 수 있습니다. http://localhost:8080.

Experience Manager 프로젝트의 Dispatcher 구성에 대해 Dispatcher 도구를 실행하려면 프로젝트의 dispatcher/src 폴더를 삭제합니다.

$ ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080
$ bin\docker_run <User Directory>/code/my-project/dispatcher/src host.docker.internal:4503 8080
$ ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

Dispatcher 도구 로그

Dispatcher 로그는 HTTP 요청이 차단되는지 여부와 차단되는 이유를 이해하는 로컬 개발 중에 유용합니다. 로그 수준은 다음을 실행 앞에 추가하여 설정할 수 있습니다. docker_run 환경 매개 변수와 함께 사용하십시오.

Dispatcher 도구 로그는 다음의 경우에 표준으로 내보내집니다. docker_run 가 실행되었습니다.

Dispatcher 디버깅에 유용한 매개 변수는 다음과 같습니다.

  • DISP_LOG_LEVEL=Debug dispatcher 모듈 로깅을 디버그 수준으로 설정합니다.
    • 기본값은 입니다. Warn
  • REWRITE_LOG_LEVEL=Debug apache HTTP 웹 서버 재작성 모듈 로깅을 디버그 수준으로 설정합니다.
    • 기본값은 입니다. Warn
  • DISP_RUN_MODE dispatcher 환경의 "실행 모드"를 설정하여 해당 실행 모드 Dispatcher 구성 파일을 로드합니다.
    • 기본값은 입니다. dev
  • 유효한 값: dev, stage, 또는 prod

하나 이상의 매개 변수를 로 전달할 수 있습니다. docker_run

$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080
$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug bin\docker_run <User Directory>/code/my-project/dispatcher/src host.docker.internal:4503 8080
$ DISP_LOG_LEVEL=Debug REWRITE_LOG_LEVEL=Debug ./bin/docker_run_hot_reload.sh ~/code/my-project/dispatcher/src host.docker.internal:4503 8080

로그 파일 액세스

Docker 컨테이너에서 Apache 웹 서버 및 AEM Dispatcher 로그에 직접 액세스할 수 있습니다.

Dispatcher 도구를 업데이트하는 경우

Dispatcher 도구 버전은 Experience Manager에 비해 덜 자주 증가하므로 Dispatcher 도구는 로컬 개발 환경에서 더 적은 수의 업데이트를 필요로 합니다.

권장 Dispatcher 도구 버전은 Experience Manager as a Cloud Service 버전과 일치하는 AEM as a Cloud Service SDK와 번들로 제공되는 것입니다. AEM의 as a Cloud Service 버전은 다음을 통해 찾을 수 있습니다. Cloud Manager.

  • Cloud Manager > 환경​에 의해 지정된 환경당 AEM 릴리스 레이블

Experience Manager 버전

Dispatcher 도구 버전이 Experience Manager 버전과 일치하지 않습니다.

Apache 및 Dispatcher 구성의 기본 세트를 업데이트하는 방법

Apache 및 Dispatcher 구성의 기본 세트가 정기적으로 향상되고 AEM as a Cloud Service SDK 버전과 함께 릴리스됩니다. 가장 좋은 방법은 AEM 프로젝트에 기준선 구성 개선 사항을 통합하고 로컬 유효성 검사 및 Cloud Manager 파이프라인 오류가 발생했습니다. 다음을 사용하여 업데이트 update_maven.sh 다음에서 스크립트: .../dispatcher-sdk-x.x.x/bin 폴더를 삭제합니다.

이 비디오는 설명 목적으로 macOS을 사용합니다. 동일한 Windows/Linux 명령을 사용하여 유사한 결과를 얻을 수 있습니다.

을 사용하여 과거에 AEM 프로젝트를 만들었다고 가정합니다. AEM Project Archetype, 기본 Apache 및 Dispatcher 구성은 최신 상태입니다. 이러한 기준 구성을 사용하여 다음과 같은 파일을 다시 사용하고 복사하여 프로젝트별 구성을 작성했습니다 *.vhost, *.conf, *.farm*.any 다음에서 dispatcher/src/conf.ddispatcher/src/conf.dispatcher.d 개 폴더. 로컬 Dispatcher 유효성 검사 및 Cloud Manager 파이프라인이 제대로 작동했습니다.

한편, 새로운 기능, 보안 수정 및 최적화와 같은 다양한 이유로 인해 기본 Apache 및 Dispatcher 구성이 개선되었습니다. AEM as a Cloud Service 릴리스의 일부로 새 버전의 Dispatcher 도구를 통해 릴리스됩니다.

이제, 최신 Dispatcher 도구 버전에 대해 프로젝트별 Dispatcher 구성을 확인할 때 오류가 발생합니다. 이 문제를 해결하려면 아래 단계를 사용하여 기준 구성을 업데이트해야 합니다.

  • 최신 Dispatcher 도구 버전에 대해 유효성 검사가 실패하는지 확인

    $ ./bin/validate.sh ${YOUR-AEM-PROJECT}/dispatcher/src
    
    ...
    Phase 3: Immutability check
    empty mode param, assuming mode = 'check'
    ...
    ** error: immutable file 'conf.d/available_vhosts/default.vhost' has been changed!
    
  • 를 사용하여 변경할 수 없는 파일 업데이트 update_maven.sh script

    $ ./bin/update_maven.sh ${YOUR-AEM-PROJECT}/dispatcher/src
    
    ...
    Updating dispatcher configuration at folder
    running in 'extract' mode
    running in 'extract' mode
    reading immutable file list from /etc/httpd/immutable.files.txt
    preparing 'conf.d/available_vhosts/default.vhost' immutable file extraction
    ...
    immutable files extraction COMPLETE
    fd72f4521fa838daaaf006bb8c9c96ed33a142a2d63cc963ba4cc3dd228948fe
    Cloud manager validator 2.0.53
    
  • 다음과 같이 업데이트된 변경 불가능한 파일을 확인합니다. dispatcher_vhost.conf, default.vhost, 및 default.farm 필요한 경우 이러한 파일에서 파생된 사용자 정의 파일을 관련 있게 변경합니다.

  • 구성을 재확인합니다. 이 경우 전달됩니다.

$ ./bin/validate.sh ${YOUR-AEM-PROJECT}/dispatcher/src

...
checking 'conf.dispatcher.d/renders/default_renders.any' immutability (if present)
checking existing 'conf.dispatcher.d/renders/default_renders.any' for changes
checking 'conf.dispatcher.d/virtualhosts/default_virtualhosts.any' immutability (if present)
checking existing 'conf.dispatcher.d/virtualhosts/default_virtualhosts.any' for changes
no immutable file has been changed - check is SUCCESSFUL
Phase 3 finished
  • 변경 사항을 로컬로 확인한 후 업데이트된 구성 파일을 커밋합니다.

문제 해결

docker_run 결과 'host.docker.internal을 사용할 수 있을 때까지 대기 중' 메시지

다음 host.docker.internal 는 Docker에 제공된 호스트 이름이며, 호스트에 대해 확인됩니다. Per docs.docker.com (macOS, Windows):

Docker 18.03 이상에서는 특별 DNS 이름 host.docker.internal에 연결하는 것이 좋습니다. 이 이름은 호스트가 사용하는 내부 IP 주소로 확인됩니다

날짜 bin/docker_run src host.docker.internal:4503 8080 메시지에 결과 표시 host.docker.internal을 사용할 수 있을 때까지 대기 중, 다음:

  1. 설치된 Docker 버전이 18.03 이상인지 확인합니다.
  2. 의 등록/해결을 방해하는 로컬 컴퓨터가 설정되어 있을 수 있습니다. host.docker.internal 이름. 대신 로컬 IP를 사용하십시오.
  • 터미널에서 다음을 실행합니다. ifconfig 및 호스트를 기록합니다. 아이넷 IP 주소, 일반적으로 en0 디바이스.

  • 그런 다음 실행 docker_run 호스트 IP 주소 사용: $ bin/docker_run_hot_reload.sh src <HOST IP>:4503 8080

  • 명령 프롬프트에서 다음을 실행합니다. ipconfig및 호스트의 기록 IPv4 주소 호스트 컴퓨터의

  • 그런 다음 를 실행합니다. docker_run 이 IP 주소 사용: $ bin\docker_run src <HOST IP>:4503 8080

  • 터미널에서 다음을 실행합니다. ifconfig 및 호스트를 기록합니다. 아이넷 IP 주소, 일반적으로 en0 디바이스.

  • 그런 다음 실행 docker_run 호스트 IP 주소 사용: $ bin/docker_run_hot_reload.sh src <HOST IP>:4503 8080

  • 오류 예

    $ docker_run src host.docker.internal:4503 8080
    
    Running script /docker_entrypoint.d/10-check-environment.sh
    Running script /docker_entrypoint.d/20-create-docroots.sh
    Running script /docker_entrypoint.d/30-wait-for-backend.sh
    Waiting until host.docker.internal is available
    

    추가 리소스

    이 페이지에서는