|
2 | 2 | aliases:
|
3 | 3 | - "04 Authentication"
|
4 | 4 | ---
|
| 5 | +# macOS |
| 6 | + |
| 7 | +## HTTPS |
| 8 | + |
| 9 | +Run the following to use the macOS keychain to store your credentials. |
| 10 | + |
| 11 | +```bash |
| 12 | +git config --global credential.helper osxkeychain |
| 13 | +``` |
| 14 | + |
| 15 | +You have to do one authentication action (clone/pull/push) after setting the helper in the terminal. After that you should be able to clone/pull/push in Obsidian without any issues. |
| 16 | + |
| 17 | +## SSH |
| 18 | + |
| 19 | +Remember you still have to setup ssh correctly, like adding your SSH key to the `ssh-agent`. GitHub provides a great documentation on how to [generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=mac#generating-a-new-ssh-key) and then on how to [add the SSH key to your ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=mac#adding-your-ssh-key-to-the-ssh-agent). |
| 20 | + |
| 21 | +# Windows |
| 22 | + |
| 23 | +## HTTPS |
| 24 | + |
| 25 | +Ensure you are using Git 2.29 or higher and you are using Git Credential Manager as a credential helper. |
| 26 | +You can verify this by executing the following snippet in a terminal, preferably in the directory where your vault/repository is located. It should output `manager`. |
| 27 | + |
| 28 | +```bash |
| 29 | +git config credential.helper |
| 30 | +``` |
| 31 | + |
| 32 | +If this doesn't output `manager`, please run `git config set credential.helper manager` |
| 33 | +Just execute any authentication command like push/pull/clone and a pop window should come up, allowing your to sign in. |
| 34 | + |
| 35 | +Alternatively, you can also leave that setting empty and always provide the username and password manually via the prompted modal in Obsidian. All available credential helpers are listed [here](https://git-scm.com/doc/credential-helpers)., |
| 36 | + |
| 37 | +## SSH |
| 38 | +Remember you still have to setup ssh correctly, like adding your SSH key to the `ssh-agent`. GitHub provides a great documentation on how to [generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=windows#generating-a-new-ssh-key) and then on how to [add the SSH key to your ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=windows#adding-your-ssh-key-to-the-ssh-agent). |
| 39 | + |
5 | 40 | # Linux
|
6 | 41 |
|
7 | 42 | ## HTTPS
|
@@ -50,40 +85,3 @@ The plugin now automatically provides an integrated script for the `SSH_ASKPASS`
|
50 | 85 |
|
51 | 86 | ## SSH
|
52 | 87 | With one of the above [[#SSH_PASS Tools]] installed to enter your passphrase, you can use ssh with a passphrase. Remember you still have to setup ssh correctly, like adding your SSH key to the `ssh-agent`. GitHub provides a great documentation on how to [generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=linux#generating-a-new-ssh-key) and then on how to [add the SSH key to your ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=linuxu#adding-your-ssh-key-to-the-ssh-agent).
|
53 |
| - |
54 |
| -# macOS |
55 |
| - |
56 |
| -## HTTPS |
57 |
| - |
58 |
| -Run the following to use the macOS keychain to store your credentials. |
59 |
| - |
60 |
| -```bash |
61 |
| -git config --global credential.helper osxkeychain |
62 |
| -``` |
63 |
| - |
64 |
| -You have to do one authentication action (clone/pull/push) after setting the helper in the terminal. After that you should be able to clone/pull/push in Obsidian without any issues. |
65 |
| - |
66 |
| -## SSH |
67 |
| - |
68 |
| -Remember you still have to setup ssh correctly, like adding your SSH key to the `ssh-agent`. GitHub provides a great documentation on how to [generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=mac#generating-a-new-ssh-key) and then on how to [add the SSH key to your ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=mac#adding-your-ssh-key-to-the-ssh-agent). |
69 |
| - |
70 |
| -# Windows |
71 |
| - |
72 |
| -## HTTPS |
73 |
| - |
74 |
| -Ensure you are using Git 2.29 or higher and you are using Git Credential Manager as a credential helper. |
75 |
| -You can verify this by executing the following snippet in a terminal, preferably in the directory where your vault/repository is located. It should output `manager`. |
76 |
| - |
77 |
| -```bash |
78 |
| -git config credential.helper |
79 |
| -``` |
80 |
| - |
81 |
| -If this doesn't output `manager`, please run `git config set credential.helper manager` |
82 |
| -Just execute any authentication command like push/pull/clone and a pop window should come up, allowing your to sign in. |
83 |
| - |
84 |
| -Alternatively, you can also leave that setting empty and always provide the username and password manually via the prompted modal in Obsidian. All available credential helpers are listed [here](https://git-scm.com/doc/credential-helpers)., |
85 |
| - |
86 |
| -## SSH |
87 |
| -Remember you still have to setup ssh correctly, like adding your SSH key to the `ssh-agent`. GitHub provides a great documentation on how to [generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=windows#generating-a-new-ssh-key) and then on how to [add the SSH key to your ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=windows#adding-your-ssh-key-to-the-ssh-agent). |
88 |
| - |
89 |
| - |
0 commit comments