Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 1.91 KB

README.md

File metadata and controls

55 lines (42 loc) · 1.91 KB
Raw

Qlever-LLC/zendesk-sync

Coverage Status Docker Pulls code style: prettier License

Usage

Docker images for Qlever-LLC/zendesk-sync are available from GitHub Container Registry.

docker-compose

Here is an example of using this service with docker-compose.

services:
  service:
    image: Qlever-LLC/zendesk-sync
    restart: unless-stopped
    environment:
      NODE_TLS_REJECT_UNAUTHORIZED:
      NODE_ENV=: ${NODE_ENV:-development}
      DEBUG: ${DEBUG-*:error,*:warn,*:info}
      # Connect to host if DOMAIN not set.
      # You should really not rely on this though. Set DOMAIN.
      DOMAIN: ${DOMAIN:-host.docker.internal}
      # Unless your API server is running with development tokens enabled,
      # you will need to give the service token(s) to use.
      TOKEN: ${TOKEN:-abc123,def456}

Running Qlever-LLC/zendesk-sync within the OADA Reference API Server

To add this service to the services run with an OADA v3 server, simply add a snippet like the one in the previous section to your docker-compose.override.yml.

External Usage

To run this service separately, simply set the domain and token(s) of the OADA API.

# Set up the environment.
# Only need to run these the first time.
echo DOMAIN=api.oada.example.com > .env # Set API domain
echo TOKEN=abc123 >> .env # Set API token(s) for the service

# Start the service
docker-compose up -d