Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fpopic/.gitconfig-setup
https://github.com/fpopic/.gitconfig-setup
git gitconfig github gitlab gpg pbcopy ssh
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fpopic/.gitconfig-setup
- Owner: fpopic
- Created: 2022-07-02T17:50:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-22T19:56:48.000Z (about 2 years ago)
- Last Synced: 2023-08-02T10:09:48.396Z (over 1 year ago)
- Topics: git, gitconfig, github, gitlab, gpg, pbcopy, ssh
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# .gitconfig-setup
How to prepare your git environment to work:
- with different auth `ssh` and signing `gpg` keys
- with different git hosts (e.g. GitHub, GitLab) and organization (private account, company account)
- with automatic key selection based on the folder path and ssh host
Steps:
1. Generate new [SSH private key(s)](https://docs.gitlab.com/ee/user/ssh.html#generate-an-ssh-key-pair)
- Generating a private key with a **passphrase** is a requirement on Mac :warning:
```shell
$ ssh-keygen -t ED25519 -C "[email protected]" -f ~/.ssh/id_org1_github
$ pbcopy ~/.ssh/id_org1_github.pub
$ open https://github.com/settings/keys
$ ssh-keygen -t ED25519 -C "[email protected]" -f ~/.ssh/id_org3_gitlab
$ pbcopy ~/.ssh/id_org3_gitlab.pub
$ open https://gitlab.com/-/profile/keys
```
- [Make keys "persistent"](https://unix.stackexchange.com/a/560404/171941) automatically loaded after Mac reboot
- Update `~/.ssh/config` file:
```config
Host *
UseKeychain yes
AddKeysToAgent yes
IgnoreUnknown UseKeychain
Host org1-github
user = git
HostName = github.com
identityfile = ~/.ssh/id_org1_github
identitiesonly yes
Host org3-gitlab
HostName = gitlab.com
user = git
identityfile = ~/.ssh/id_org3_gitlab
identitiesonly yes
```
- For GitHub make sure you authorized your ssh key with [your organization via SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)
1. Generate new [GPG signing key(s)](https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/)
- Execute
```shell
$ gpg --gen-key
```
- Note your GPG key ID, It begins after the `/` character in the `sec` paragraph after executing:
```shell
$ gpg --list-secret-keys --keyid-format LONG [email protected]
sec rsa3072/ 2022-03-03 [SC]
5A233D97F169400541080D50D58FC20EB4027CXX
uid [ultimate] first last
ssb rsa3072/560358F2315DB6XX 2022-03-03 [E]
```
1. Set up `~/.gitconfig` so that it automatically picks up your git config based on the folder prefix
- We suggest to follow folder paths for all git repositories
```shell
~/Projects
├── github
│ ├── my-organisation1
│ │ ├── repo-1
│ │ └── ...
│ └── my-organisation2
│ ├── repo-2
│ └── ...
├── gitlab
│ └── my-organisation3
│ ├── repo-3
│ └── ...
├── bitbucket
│ └── my-organisation4
│ ├── repo-4
│ └── ...
...
```
- `~/.gitconfig`
```ini
[commit]
gpgsign = true
[includeIf "gitdir:~/Projects/github/my-organisation1/"]
path = ~/.gitconfig-github-my-organisation1
[includeIf "gitdir:~/Projects/gitlab/my-organisation3/"]
path = ~/.gitconfig-gitlab-my-organisation3
```
- `~/.gitconfig-github-my-organisation1`
```ini
[user]
email = [email protected]
name = your-github-username
signingkey = your GPG key ID
[url "ssh://git@org1-github/umg/"]
insteadOf = [email protected]:org1/
```
- `~/.gitconfig-gitlab-my-organisation3`
```ini
[user]
email = [email protected]
name = your-gitlab-username
signingkey = your GPG key ID
[url "ssh://git@org3-gitlab/umg/"]
insteadOf = [email protected]:org3/
```
4. Make sure everything works by cloning some repositories using git ssh protocol
## Troubleshooting
1. Read git config variables from respective paths
```shell
$ cd ~/Projects/github/my-organisation1/repo-1 on main
$ git config --show-origin --get user.name
file:~/.gitconfig-github-my-organisation1 your-github-username
```
```shell
$ cd ~/Projects/gitlab/my-organisation3/repo-3 on main
$ git config --show-origin --get user.name
file:~/.gitconfig-gitlab-my-organisation3 your-gitlab-username
```
1. If you get the error: `gpg failed to sign the data` try running `$ export GPG_TTY=$(tty)` before committing and add it to your `~/.zshrc` config if it helped
```shell
$ echo 'export GPG_TTY=$(tty)' >> ~/.zshrc
$ source ~/.zshrc
```
1. Check ssh auth log what is happening under the hood
```shell
$ ssh -Tv [email protected]
```