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

docs: change git clone to https:// link #17

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ethanmuller
Copy link

I ran into a little snag while setting up a new laptop (running Mojave).

Using git clone [email protected]:sparkbox/laptop.git didn't work for a fresh install. The https:// link did.

Using `git clone [email protected]:sparkbox/laptop.git` didn't work for me
on a fresh Mojave install. The https:// link did.
@yock
Copy link

yock commented Jan 25, 2019

@ethanmuller Would it make sense to have adding your public key to Github as a prerequisite to running the laptop script rather than using HTTPS?

@ethanmuller
Copy link
Author

@yock What's the benefit of using a [email protected]: link over HTTPS?

As long as it's nothing major, I think it'd make sense to include instructions for that after this point in the readme.

I like the idea of putting that somewhere though! Setting that up is really relevant to this process, and I wasn't looking forward to digging around to find it.

@yock
Copy link

yock commented Jan 25, 2019

@ethanmuller SSH is the preferred way to authenticate with Github anyway and it would help us ensure from the get-go that it's working correctly.

@ethanmuller
Copy link
Author

@yock What benefits does SSH provide over HTTPS for somebody trying to run this script?

I'm picturing a new hire* with a fresh laptop trying to run this script. Maybe they haven't gone through the process of setting up public keys yet. I think it'd streamline things for them if we switch this to HTTPS, to eliminate the possibility of them getting hung up on SSH stuff.


* or me trying to run this script last night, having a bad time 😉

@yock
Copy link

yock commented Jan 26, 2019

@ethanmuller I think the main benefit here is that we ensure, from the start, that we are preferring SSH over HTTPS. If this seems reasonable I'm happy to take on making this easier by improving the docs, the laptop script, or both.

@ethanmuller
Copy link
Author

@yock Yeah... I guess don't feel too strongly on exactly how we improve the documentation. I mostly care that it gets improved in the first place, since it failed for me.

I still don't quite understand why we prefer SSH over HTTPS. GitHub recommends using HTTPS. Is SSH more secure somehow?

@yock
Copy link

yock commented Jan 26, 2019

Github recommends HTTPS for portability concerns. They don’t have to ask what platform you’re using if they just say “use HTTPS.” PKI is more secure than username and password authentication. This Security StackExchange thread is a good summary. Parts of it are irrelevant from our point of view (as long as you’re using 1Password) but much of it is universally applicable.

https://security.stackexchange.com/questions/3605/certificate-based-authentication-vs-username-and-password-authentication

My opinion is one of many on this team and not authoritative. If others similarly believe that HTTPS vs SSH isn’t a big deal then that’s fine.

@ethanmuller
Copy link
Author

ethanmuller commented Jan 26, 2019

@yock If we could find a way to clearly explain this process to the people running this script, I'd be into the idea of putting that first!

My main motivation with this PR was to make running the script a little easier.

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.

2 participants