archive-gh-me/gitbeaker
1
0
Fork 0
mirror of https://github.com/jdalrymple/gitbeaker.git synced 2026-01-25 16:04:01 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #259 from EvHaus/patch-2

Browse Source 
docs: Update README.md with `rejectUnauthorized`
This commit is contained in:
jdalrymple 2019-01-30 17:16:52 -05:00 committed by GitHub
commit 4babf7b920
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -149,7 +149,7 @@ const Gitlab = require('gitlab/dist/es5').default
// Instantiating
const api = new Gitlab({
url: 'http://example.com', // Defaults to https://gitlab.com
token: 'abcdefghij123456' // Can be created in your profile.
token: 'abcdefghij123456' // Can be created in your profile.
})
// Or, use a OAuth token instead!
@ -268,6 +268,28 @@ EpicNotes
EpicDiscussions
```
#### Handling HTTPS certificates
If your Gitlab server is running via HTTPS, the proper way to pass in your certificates is via a `NODE_EXTRA_CA_CERTS` environment key, like this:
```js
"scripts": {
"start": "NODE_EXTRA_CA_CERTS=./secrets/3ShapeCA.pem node bot.js"
},
```
Although we don't encourage it, if you absolutely must allow insecure certificates, you can instantiate the API with `rejectAuthorized` set to `true` like this:
```
const api = new Gitlab({
url: '...',
token: '...',
rejectUnauthorized: true
})
```
> **NOTE**: _Using `process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'` will not work with the `gitlab` library. The `rejectUnauthorized` key is the only way to allow insecure certificates to be bypassed._
### Using XMLHttpRequest
This package uses the [Request](https://github.com/request/request) library by default, which is built into Node. However, if your code is running in a browser, you can get better built-in resolution of proxies and self-signed certificates by using the browser's XMLHttpRequest implementation instead: