Skip to content

Commit

Permalink
Merge pull request #29 from natemccurdy/docs/ghe
Browse files Browse the repository at this point in the history
Update the README with info about GitHub Enterprise
  • Loading branch information
abrader committed Jun 8, 2016
2 parents 3e3da10 + 8f0bbc1 commit b4b790c
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ Both http & https URLs are acceptable.
server_url => 'http://my.internal.gms.server.example.com',
```

If using GitHub Enterprise, add `/api/v3` to the URL, and you'll probably need to use https:

```puppet
server_url => 'https://my.internal.gms.server.example.com/api/v3',
```

#### provider

The Git Management System you are currently using in reference to the webhook you are managing. Currently only GitHub and GitLab are supported.
Expand Down Expand Up @@ -109,6 +115,12 @@ name => 'One of my unique deploy keys',

GitHub and GitLab utilize a token based authentication system to access their APIs respectively

The API token generated must have admin permissions and the ability to read/write keys. If the permissions are wrong, you'll likely see the following error message:

```
...can't convert String into Integer...
```

#### token
This is the unique token you created within your GMS to allow you to interface with the system via the API.

Expand Down

0 comments on commit b4b790c

Please sign in to comment.