-
Notifications
You must be signed in to change notification settings - Fork 193
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update installation instructions in the README #309
Conversation
I expanded the installation instructions in the README in order to address a few pain points I had while setting up badssl.
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed, please reply here (e.g.
|
I signed it! |
CLAs look good, thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Looks pretty good; I left a few nits.
README.md
Outdated
cp gen/key/ca-root.key pregen/key/ca-root.key | ||
6. The badssl root certificate is at `certs/sets/test/gen/crt/ca-root.crt`. In order to get the rest of the badssl subdomains working, you will need to add this to your machine's list of trusted certificates. | ||
|
||
##### Mac OS X |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: macOS
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea! I moved it to a sub-bullet.
README.md
Outdated
make list-hosts # list of domains to copy into /etc/hosts | ||
2. Clone into the badssl repo by running `git clone https://github.com/chromium/badssl.com && cd badssl.com`. | ||
|
||
3. In order to access the various badssl subdomains locally you will need to add them to your [system hosts file](http://bencane.com/2013/10/29/managing-dns-locally-with-etchosts/). Run `make list-hosts` and copy and paste the output into `/etc/hosts`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: link to HTTPS version of that page. ;-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops! Done.
- Changed a http link -> https - Move the macOS X root certificate instructions to a sub bullet
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've never used this GitHub changes interface, so hopefully I did this right! I just addressed your comments.
README.md
Outdated
make list-hosts # list of domains to copy into /etc/hosts | ||
2. Clone into the badssl repo by running `git clone https://github.com/chromium/badssl.com && cd badssl.com`. | ||
|
||
3. In order to access the various badssl subdomains locally you will need to add them to your [system hosts file](http://bencane.com/2013/10/29/managing-dns-locally-with-etchosts/). Run `make list-hosts` and copy and paste the output into `/etc/hosts`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops! Done.
README.md
Outdated
cp gen/key/ca-root.key pregen/key/ca-root.key | ||
6. The badssl root certificate is at `certs/sets/test/gen/crt/ca-root.crt`. In order to get the rest of the badssl subdomains working, you will need to add this to your machine's list of trusted certificates. | ||
|
||
##### Mac OS X |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea! I moved it to a sub-bullet.
Thanks! |
I expanded the installation instructions in the README in order to address a few pain points I had while setting up badssl.