Skip to content

Commit c3ca862

Browse files
committed
docs: add minor guide to star with new repo on desktop
1 parent 2f72421 commit c3ca862

File tree

2 files changed

+46
-37
lines changed

2 files changed

+46
-37
lines changed

docs/Authentication.md

Lines changed: 35 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,41 @@
22
aliases:
33
- "04 Authentication"
44
---
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+
540
# Linux
641

742
## HTTPS
@@ -50,40 +85,3 @@ The plugin now automatically provides an integrated script for the `SSH_ASKPASS`
5085

5186
## SSH
5287
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-

docs/Getting Started.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
11
# Desktop
2+
You can either start by cloning an existing remote repository as described [[#For existing remote repository|here]] or start with initializing a new repository locally and optionally push that to a remote repository as described [[#Create new local repository|here]].
3+
4+
## Create new local repository
5+
6+
1. Follow the [[Installation]] instructions for your operating system
7+
2. Call the `Initialize a new repo` command
8+
3. Create your first commit by creating some files and calling the `Commit all changes with specific message` command
9+
4. If you want to Setup to push it to a remote repository like to GitHub:
10+
1. Setup [[Authentication]]
11+
2. Ensure that the remote repository is empty. Otherwise delete the repository and instead proceed to clone the remote repository as described in the [[#For existing remote repository|next section]].
12+
3. Call the `Push` command. It should ask you for a name and URL of the remote repository. Just enter `origin` for the remote name and copy the URL to push to somewhere from your remote git service.
213

314
## For existing remote repository
415

0 commit comments

Comments
 (0)