Skip to content

Commit

Permalink
Merge pull request #107 from snyk/fix/documentation
Browse files Browse the repository at this point in the history
fix: ghe docker documentation
  • Loading branch information
orsagie authored Feb 22, 2018
2 parents 6bd32c1 + c3552fe commit 4965b13
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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
Expand All @@ -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
```
Expand Down
4 changes: 2 additions & 2 deletions dockerfiles/github-enterprise/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4965b13

Please sign in to comment.