{"type":"doc","content":[{"type":"panel","attrs":{"panelIconId":"atlassian-info","panelIcon":":info:","panelColor":"#FFBDAD","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-installation-and-upgrade-guides/zephyr-on-premise-production-installation/zephyr-enterprise-services/ze---webhook-deployment.html"}},{"text":" ","type":"text"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"2"},"outline":{"value":"false"},"style":{"value":"none"},"type":{"value":"list"},"printable":{"value":"false"}},"macroMetadata":{"macroId":{"value":"421338a9-b48c-4288-b7d9-2b5a7ed2b7ee"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"b882905e-ba45-40fa-8f6d-3d90bf2fd4f1"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Prerequisite","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install Java 17.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure your Zephyr and Rabbit MQ application is set up and running, For RabbitMq Setup follow the instructions on the following page: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://smartbear.atlassian.net/wiki/spaces/PD/pages/3852992664"}},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"[By launching the application in the browser:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Launch Zephyr with your respective host/domain. Ex: ","type":"text"},{"text":"https://test.yourzephyr.com","type":"text","marks":[{"type":"link","attrs":{"href":"https://test.yourzephyr.com"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Launch RabbitMq with the host and configured port. Ex: ","type":"text"},{"text":"http://localhost:15672","type":"text","marks":[{"type":"link","attrs":{"href":"http://localhost:15672)/"}}]},{"text":"]","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Launch RabbitMq Management in the browser with the host and port (Ex: ","type":"text"},{"text":"http://localhost:15672","type":"text","marks":[{"type":"link","attrs":{"href":"http://localhost:15672"}}]},{"text":").","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Webhook Service Deployment (Jar): -","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a directory under folder opt “zephyrservice”","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"mkdir zephyrservice","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Download the ","type":"text"},{"text":"ze-jira-webhook.jar","type":"text","marks":[{"type":"link","attrs":{"href":"https://support.smartbear.com/zephyr-enterprise/downloads/"}}]},{"text":" and copy it under ","type":"text"},{"text":"zephyrservice","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a ze-jira-webhook config file Named “","type":"text"},{"text":"zeJiraWebhook.properties","type":"text","marks":[{"type":"code"}]},{"text":"\" under folder ","type":"text"},{"text":"zephyrservice","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"codeBlock","content":[{"text":"vi zeJiraWebhook.properties","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the below line in the file ","type":"text"},{"text":"zeJiraWebhook.properties","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"#Webhook Service port\nserver.port=8081\n\n#context path property\nserver.servlet.context-path=/webhook\n\n#Rabbitmq config\nzephyr.queue.name=ze_queue\nzephyr.queue.exchange=ze_exchange\nzephyr.queue.routing.key=ze_routing_key\n\nspring.rabbitmq.host=\nspring.rabbitmq.port=\nspring.rabbitmq.username=\nspring.rabbitmq.password=\n\n#ze_jira_webhook flags\nevent.validator.json.file=classpath:webhook-events-validation.json\nze.jira.webhook.event.validation_flag = false\n\n#ssl properties \n#uncomment the below line and add the SSL \n#server.ssl.enabled=true\n#server.ssl.key-store-type=PKCS12\n#server.ssl.key-alias=\n#server.ssl.key-store=file:\n#server.ssl.key-store-password=","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An example of ","type":"text"},{"text":"zeJiraWebhook.properties","type":"text","marks":[{"type":"code"}]},{"text":" should look like the below: - ","type":"text"},{"type":"mediaInline","attrs":{"id":"195fd77f-3744-4923-b071-245fe163a127","collection":"contentId-3844669540"}},{"text":" ","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"yaml"},"content":[{"text":"#Webhook Service port\nserver.port=8081\n\n#context path property\nserver.servlet.context-path=/webhook\n\n#Rabbitmq config\nzephyr.queue.name=ze_queue\nzephyr.queue.exchange=ze_exchange\nzephyr.queue.routing.key=ze_routing_key\nspring.rabbitmq.host=localhost\nspring.rabbitmq.port=5672\nspring.rabbitmq.username=guest\nspring.rabbitmq.password=guest\n\n# ze_jira_webhook flags\nevent.validator.json.file=classpath:webhook-events-validation.json\nze.jira.webhook.event.validation_flag = false\n\n#ssl properties\nserver.ssl.enabled=true\nserver.ssl.key-store-type=PKCS12\nserver.ssl.key-alias=mycert\nserver.ssl.key-store=file:/home/ubuntu/keystore.p12\nserver.ssl.key-store-password=changeit","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make sure port 8081 is available.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"zeJiraWebhook should be able to connect with RabbitMQ.","type":"text"}]}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Open the “Terminal” or “Command Prompt”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Navigate to folder /opt/zephyrservice","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type the below command:","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Start the ze-jira-webhook with the following command.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"sudo nohup java -jar -DzeWebhookConfigPath=\"\" ze-jira-webhook_.jar &","type":"text"}]},{"type":"paragraph","content":[{"text":"Example command:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"sudo nohup java -jar -DzeWebhookConfigPath=\"//opt/zephyrservice\" ze-jira-webhook.jar &","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Log","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Logs folder will be created where your jars are deployed. Separate log files will be created for each jar. In the above example, it will be in /opt/zephyrservice.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Verification","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Verify webhook application status by using ","type":"text"},{"text":"http://:8080/webhook/actuator/health","type":"text","marks":[{"type":"link","attrs":{"href":"http://localhost:8080/actuator/health"}}]}]},{"type":"paragraph","content":[{"text":"Webhook started snapshot for reference: -","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":936,"alt":"1ed0b601-7787-4195-a88a-646535cddfea.png","id":"3dd13f97-87f8-4511-a3fd-68e4d00584fd","collection":"contentId-3844669540","type":"file","height":98}}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Verification in the browser:","type":"text","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1614,"alt":"image-20240318-092543.png","id":"2d46a3ca-8628-48af-b175-5269e38c538c","collection":"contentId-3844669540","type":"file","height":292}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Webhook Service Deployment (Docker): -","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install Docker in the System","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a directory under folder opt “zephyrservice”","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"mkdir zephyrservice","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Download the ","type":"text"},{"text":"Docker compose","type":"text","marks":[{"type":"link","attrs":{"href":"https://support.smartbear.com/zephyr-enterprise/downloads/"}}]},{"text":" and copy it under ","type":"text"},{"text":"zephyrservice","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"mediaInline","attrs":{"id":"1dc8f466-673e-44c0-90d5-6a8c52423713","collection":"contentId-3844669540"}},{"text":" ","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"#dockercompose\n\nversion: '3.5'\nservices:\n\n #webhookservice\n ze-jira-webhook:\n image: smartbear/zejirawebhook:ze-jira-webhook\n container_name: ze-jira-webhook\n ports:\n - \"8081:8081\"\n - \"8000:8000\"\n environment:\n - server_port=8081\n volumes:\n - ./zeJiraWebhook.properties:/usr/src/app/zeJiraWebhook.properties\n networks:\n - webhook_service\n\nnetworks:\n webhook_service:\n name: zephyr\n external: true","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a ze-jira-webhook config file Named “","type":"text"},{"text":"zeJiraWebhook.properties","type":"text","marks":[{"type":"code"}]},{"text":"\" under folder ","type":"text"},{"text":"zephyrservice","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"codeBlock","content":[{"text":"vi zeJiraWebhook.properties","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the below line in the file ","type":"text"},{"text":"zeJiraWebhook.properties","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"yaml"},"content":[{"text":"#Webhook Service port\nserver.port=8081\n\n#context path property\nserver.servlet.context-path=/webhook\n\n#Rabbitmq config\nzephyr.queue.name=ze_queue\nzephyr.queue.exchange=ze_exchange\nzephyr.queue.routing.key=ze_routing_key\n\nspring.rabbitmq.host=\nspring.rabbitmq.port=\nspring.rabbitmq.username=\nspring.rabbitmq.password=\n\n#ze_jira_webhook flags\nevent.validator.json.file=classpath:webhook-events-validation.json\nze.jira.webhook.event.validation_flag = false\n\n#ssl properties \n#uncomment the below line and add the SSL \n#server.ssl.enabled=true\n#server.ssl.key-store-type=PKCS12\n#server.ssl.key-alias=\n#server.ssl.key-store=file:\n#server.ssl.key-store-password=","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An example of ","type":"text"},{"text":"zeJiraWebhook.properties","type":"text","marks":[{"type":"code"}]},{"text":" should look like the below: - ","type":"text"},{"type":"mediaInline","attrs":{"id":"195fd77f-3744-4923-b071-245fe163a127","collection":"contentId-3844669540"}},{"text":" ","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"yaml"},"content":[{"text":"#Webhook Service port\nserver.port=8081\n\n#context path property\nserver.servlet.context-path=/webhook\n\n#Rabbitmq config\nzephyr.queue.name=ze_queue\nzephyr.queue.exchange=ze_exchange\nzephyr.queue.routing.key=ze_routing_key\nspring.rabbitmq.host=localhost\nspring.rabbitmq.port=5672\nspring.rabbitmq.username=guest\nspring.rabbitmq.password=guest\n\n# ze_jira_webhook flags\nevent.validator.json.file=classpath:webhook-events-validation.json\nze.jira.webhook.event.validation_flag = false\n\n#ssl properties\nserver.ssl.enabled=true\nserver.ssl.key-store-type=PKCS12\nserver.ssl.key-alias=mycert\nserver.ssl.key-store=file:/home/ubuntu/keystore.p12\nserver.ssl.key-store-password=changeit","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make sure port 8081 is available.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"zeJiraWebhook should be able to connect with RabbitMQ.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Start the ze-jira-webhook with docker with the following command:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Navigate to zephyrservice and run the below command.","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"docker-compose up -d ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Verification","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Webhook started snapshot for reference: -","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":960,"alt":"webhook.PNG","id":"f092ea01-a77c-401a-854f-464570d31409","collection":"contentId-3844669540","type":"file","height":101}}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Verification in the browser:","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Verify webhook application status by using ","type":"text"},{"text":"http://:8081/webhook/actuator/health","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1614,"alt":"image-20240318-092543 (1).png","id":"abd26c05-4c8a-4a92-9006-4f47cb8fef2d","collection":"contentId-3844669540","type":"file","height":292}}]},{"type":"paragraph"}],"version":1}

Browser not supported