Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFBDAD

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: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-installation---upgrade-guides/zephyr-on-premise-production-installation/zephyr-enterprise-services/ze---webhook-deployment.html

Table of Contents
minLevel1
maxLevel2
outlinefalse
stylenone
typelist
printablefalse

...

  • An example of zeJiraWebhook.properties should look like the below: -

    View file
    namezeJiraWebhook (1).properties

Code Block
languageyaml
#Webhook Service port
server.port=8081

#context path property
server.servlet.context-path=/webhook

#Rabbitmq config
zephyr.queue.name=ze_queue
zephyr.queue.exchange=ze_exchange
zephyr.queue.routing.key=ze_routing_key
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest

# ze_jira_webhook flags
event.validator.json.file=classpath:webhook-events-validation.json
ze.jira.webhook.event.validation_flag = false

#ssl properties
server.ssl.enabled=true
server.ssl.key-store-type=PKCS12
server.ssl.key-alias=mycert
server.ssl.key-store=file:/home/ubuntu/keystore.p12
server.ssl.key-store-password=changeit

...

  • Open the “Terminal” or “Command Prompt”

  • Navigate to folder /opt/zephyrservice

  • Type the below command:

Start the ze-jira-webhook with the following command.

...

Code Block
#dockercompose

version: '3.5'
services:

  #webhookservice
  ze-jira-webhook:
    image: zephyrdevbotsmartbear/zedevserviceszejirawebhook:ze-jira-webhook
    container_name: ze-jira-webhook
    ports:
      - "8081:8081"
      - "8000:8000"
    environment:
      - server_port=8081
    volumes:
      - ./zeJiraWebhook.properties:/usr/src/app/zeJiraWebhook.properties
    networks:
      - webhook_service

networks:
  webhook_service:
    name: zephyr
    external: true

...

  • An example of zeJiraWebhook.properties should look like the below: -

    View file
    namezeJiraWebhook (2).properties

Code Block
languageyaml
#Webhook Service port
server.port=8081

#context path property
server.servlet.context-path=/webhook

#Rabbitmq config
zephyr.queue.name=ze_queue
zephyr.queue.exchange=ze_exchange
zephyr.queue.routing.key=ze_routing_key
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest

# ze_jira_webhook flags
event.validator.json.file=classpath:webhook-events-validation.json
ze.jira.webhook.event.validation_flag = false

#ssl properties
server.ssl.enabled=true
server.ssl.key-store-type=PKCS12
server.ssl.key-alias=mycert
server.ssl.key-store=file:/home/ubuntu/keystore.p12
server.ssl.key-store-password=changeit
Info
  • Make sure port 8081 is available.

  • zeJiraWebhook should be able to connect with RabbitMQ.

Start the ze-jira-webhook with docker with the following command:

  • Navigate to zephyrservice and run the below command.

...