diff --git a/README.md b/README.md index 377605523..3ab81d0c6 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,8 @@ To use the the broker client with a GitHub Enterprise deployment, run `docker pu - `BROKER_TOKEN` - the snyk broker token, obtained from your snyk org settings view. - `GITHUB_TOKEN` - a personal access token with full `repo` and `admin:repo_hook` scopes. - `GITHUB` - the hostname of your GitHub Enterprise deployment, such as `your.ghe.domain.com`. -- `GITHUB_API` - the API endpoint of your GitHub Enterprise deployment. Should be `$GITHUB/api/v3`. +- `GITHUB_API` - the API endpoint of your GitHub Enterprise deployment. Should be `your.ghe.domain.com/api/v3`. +- `GITHUB_GRAPHQL` - the graphql endpoint of your GitHub Enterprise deployment. Should be `your.ghe.domain.com/api`. - `PORT` - the local port at which the broker client accepts connections. Default is 7341. - `BROKER_CLIENT_URL` - the full URL of the broker client as it will be accessible by your GitHub Enterprise deployment webhooks, such as `http://my.broker.client:7341` @@ -74,6 +75,7 @@ docker run --restart=always \ -e GITHUB_TOKEN=secret-github-token \ -e GITHUB=your.ghe.domain.com \ -e GITHUB_API=your.ghe.domain.com/api/v3 \ + -e GITHUB_GRAPHQL=your.ghe.domain.com/api \ -e PORT=8000 \ -e BROKER_CLIENT_URL=http://my.broker.client:8000 \ snyk/broker:github-enterprise @@ -90,6 +92,7 @@ ENV BROKER_TOKEN secret-broker-token ENV GITHUB_TOKEN secret-github-token ENV GITHUB your.ghe.domain.com ENV GITHUB_API your.ghe.domain.com/api/v3 +ENV GITHUB_GRAPHQL your.ghe.domain.com/api ENV PORT 8000 ENV BROKER_CLIENT_URL http://my.broker.client:8000 ``` diff --git a/dockerfiles/github-enterprise/Dockerfile b/dockerfiles/github-enterprise/Dockerfile index 43d7e6190..31aa5f6ce 100644 --- a/dockerfiles/github-enterprise/Dockerfile +++ b/dockerfiles/github-enterprise/Dockerfile @@ -30,10 +30,10 @@ RUN broker init github ENV GITHUB=your.ghe.domain.com # Github API endpoint, excluding scheme. -ENV GITHUB_API $GITHUB/api/v3 +ENV GITHUB_API your.ghe.domain.com/api/v3 # Github GraphQL API endpoint, excluding scheme. -ENV GITHUB_GRAPHQL $GITHUB/api +ENV GITHUB_GRAPHQL your.ghe.domain.com/api # The port used by the broker client to accept webhooks # Default value is 7341