Skip to content

Commit 598c4a3

Browse files
committed
docs: add ssh authentication advice
1 parent 5e28b94 commit 598c4a3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ OBSIDIAN_VAULT_DIR=/path/to/your/obsidian/vault
4545
mkdir -p $OBSIDIAN_VAULT_DIR/.obsidian/plugins
4646
unzip ~/Downloads/obsidian-git_v1.1.0.zip -d $OBSIDIAN_VAULT_DIR/.obsidian/plugins
4747
```
48+
49+
## SSH Authentication
50+
> This is a typical example of a trade-off between security and convenience. [...] The most appropriate solution depends on the usage scenario and desired level of security.
51+
52+
If you want to use SSH and have a passphrase for your ssh-key, you have to add it to the ssh-agent so that Obsidian can access it. Read more at this [summary](https://unix.stackexchange.com/questions/90853/how-can-i-run-ssh-add-automatically-without-a-password-prompt/90869#90869) to start `ssh-agent` on system startup.
53+
4854
## Windows installation
4955
Make sure you have `3rd-party software` access enabled.
5056

0 commit comments

Comments
 (0)