spdy-http2 / node-spdy

SPDY server on Node.js
2.81k stars 196 forks source link

Removed CA option from README and added some comments on key/cert #264

Closed felixsanz closed 8 years ago

felixsanz commented 8 years ago

The outer options are passed directly into node https API, those are not options of node-spdy. Because of this, the README can be somewhat confusing for people who don't understand how certificates works.

Lot of new people use Let's Encrypt now, which provides chain.pem (CA file). This can be confusing and people would add that file inside ca option, which is wrong.

ca: A string, Buffer or array of strings or Buffers of trusted certificates in PEM format. If this is omitted several well known "root" CAs will be used, like VeriSign. These are used to authorize connections.

Since is not an option of node-spdy and it's just another option of many from node https API, removing it from this readme would be a good idea, since most times this option is not needed and will be missused.

Also, added some comments that can help newcomers. It's better idea to use the fullchain.pem file (Let's Encrypt provide it) than just cert.pem.

indutny commented 8 years ago

I agree, thank you!