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.

Sign up for GitHub

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

Improve README #1333

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

Improve README #1333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 15 additions & 42 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ To make **Brackets-Git** work you'll need Git installed in your system:
- **GNU/Linux**: Install the package `git`:
- [Debian/Ubuntu](https://launchpad.net/~git-core/+archive/ppa) using [this guide](http://askmetutorials.blogspot.com.au/2014/03/install-git-191-on-ubuntu-linuxmint.html):

```
sudo add-apt-repository ppa:git-core/ppa
sudo apt-get update
sudo apt-get install git
```
```
sudo add-apt-repository ppa:git-core/ppa
sudo apt-get update
sudo apt-get install git
```

- RedHat/CentOS/Fedora: `sudo yum install git`

Expand Down Expand Up @@ -46,48 +46,21 @@ A comprehensive list of Brackets-Git features is available reading the [`CHANGEL
Most of the features available are configurable and it's possible to enable and disable them selectively.
If you can't find the feature you were looking for, feel free to [open an issue](https://github.com/zaggino/brackets-git/issues) with your idea(s).

**Pull/Push to password protected repositories:**
#### Pull/Push to password protected repositories

Push/Pull from and to password protected repositories is partially supported, currently it works only with `http` / `https` repositories.

The [Git Credential Manager for Windows (GCM)](https://github.com/Microsoft/Git-Credential-Manager-for-Windows) is recommended to manage password protected repositories, **Brackets-Git** will eventually provide better support for them.
You'll need to push manually the first time to setup your username/password into the credentials helper.

**Working with SSH repositories:**
SSH protocol is currently a bit more difficult, so you'll have to use command line or try to follow these [tips](https://github.com/zaggino/brackets-git/issues/524):

- Linux
- See [help.github.com/articles/generating-ssh-keys/](https://help.github.com/articles/generating-ssh-keys/)

- Mac OSX
- Create a ssh pair key with the following command on the terminal `$ ssh-keygen -t rsa -b 2048 -C "[email protected]"`
- Enter a `"Secure"` passphrase or alternativly hit `Enter` twice if you dont want a passphrase `"Not Recommended"`
- You should be given a string like the following `"99:ff:ff:4b:bb:2d:d3:17:h6:6d:f0:55:4d:f0:b4:db [email protected]"`
- Pay attention to this line `"Your public key has been saved in /Users/USERNAME/.ssh/id_rsa.pub."` the *.pub is what you want here, take note names may vary.
- Now start the SSH agent `"eval "$(ssh-agent -s)" "` Which should give you output like this `"Agent pid 77398"`
- Next type `"ssh-add ~/.ssh/id_rsa"`
- Next we want to copy the SSH key into your clipboard, there are two ways of doing this.
- Method #1 type into Terminal `"pbcopy < ~/.ssh/id_rsa.pub"` taking note of before that "Your file" is names `"id_rsa.pub"`. If it is not, change it to whatever yours may be called. That's it proceed to next step.
- Method #2 if for some reason you can't do method #1 this is your alternative. Find the id_rsa.pub key or otherwise named.pub key and open it with a text editor, copy the while key including email into your clipboard (command + c). That's it.
- DO NOT DELETE THE FILE!

- Now we add the `SSHKEYFILE.pub` to the authorized_keys onto the git server (github website).
- Login to Github
- Click the COG to the top right (settings)
- Click the left hand side menu `"SSH KEYS"` >> ADD NEW SSH Key
- Input the name of this key, in my instance I named it `"Macbook Pro Git Key"`
- Paste your key with (command + c) or right click Paste
- Click `"ADD KEY"` and you're done (NOTE: You may be asked for a password)

- Now to test if everything is Working In Terminal Type after the $ `"ssh -T [email protected]"` Type `"Yes"` And close.
- If it does not connect, check your Internet and that you have not missed a step :)

- Windows (Go to point 3 if you have already a rsa key already generated)

- Create a ssh pair key with PuttyGen RSA with 2048 bytes. Don't add any password. Save the PPK and upload the public key to the git server.
- Add the PPK key to the Putty agent.
- ONLY IF YOU HAVE A RSA Key already from the server. You need to convert the private key to PPK. With PuttyGen load the sshkeyfilename (this file comes without extension, after loaded save it as private key. After that load this key in Putty Agent.
- Insert (if not already) the pub key to the server inside the folder `/root/.ssh/authorized_keys`. (edit with `vi` the file `authorized_keys` and paste the pub key content on the file.)
- Putty manage the private keys with a SSH agent always present in the task bar.
#### Working with SSH protocol

Instead of typing in your username and password each time you can use SSH connection.
To enable it, you should do a one-time setup.

The following manual will help you set up SSH on any operating system: [help.github.com/articles/generating-ssh-keys/](https://help.github.com/articles/generating-ssh-keys/).

Alternatively you can follow these [tips](https://github.com/zaggino/brackets-git/issues/524).

## Some screenshots:

Expand Down