Skip to content
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

Merged
merged 4 commits into from
Aug 26, 2017

Conversation

sashaperigo
Copy link
Contributor

I expanded the installation instructions in the README in order to address a few pain points I had while setting up badssl.

I expanded the installation instructions in the README in order to address a few pain points I had while setting up badssl.
@googlebot
Copy link

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!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If your company signed a CLA, they designated a Point of Contact who decides which employees are authorized to participate. You may need to contact the Point of Contact for your company and ask to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the project maintainer to go/cla#troubleshoot.
  • In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again.

@sashaperigo
Copy link
Contributor Author

I signed it!

@googlebot
Copy link

CLAs look good, thanks!

Copy link
Collaborator

@lgarron lgarron left a 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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: macOS

Copy link
Collaborator

@lgarron lgarron Aug 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, could you make this a sub-bullet of 6? Otherwise, I think some Markdown parsers will renumber #7 to #1.

Copy link
Contributor Author

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`.
Copy link
Collaborator

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. ;-)

Copy link
Contributor Author

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
Copy link
Contributor Author

@sashaperigo sashaperigo left a 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`.
Copy link
Contributor Author

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
Copy link
Contributor Author

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.

@lgarron
Copy link
Collaborator

lgarron commented Aug 26, 2017

Thanks!

@lgarron lgarron merged commit 5b700ae into chromium:master Aug 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants