From 0fc8175b4a2eec406c8bc0043a67e39129d09d01 Mon Sep 17 00:00:00 2001 From: Max Goedjen Date: Wed, 11 Nov 2020 15:17:13 -0800 Subject: [PATCH] Break out app faq --- APP_CONFIG.md | 33 +++++++++++++++++++++++++++++++++ FAQ.md | 15 ++------------- 2 files changed, 35 insertions(+), 13 deletions(-) create mode 100644 APP_CONFIG.md diff --git a/APP_CONFIG.md b/APP_CONFIG.md new file mode 100644 index 0000000..fb31f7f --- /dev/null +++ b/APP_CONFIG.md @@ -0,0 +1,33 @@ +# Setting up Third Party Apps FAQ + +## Tower + +Tower provides [instructions](https://www.git-tower.com/help/mac/integration/environment). + +## GitHub Desktop + +Should just work, no configuration needed + +## Fork + +Add this to your `~/.ssh/config` (the path should match the socket path from the setup flow). + +``` +Host * + IdentityAgent /Users/$YOUR_USERNAME/Library/Containers/com.maxgoedjen.Secretive.SecretAgent/Data/socket.ssh +``` + +## VS Code + +Add this to your `~/.ssh/config` (the path should match the socket path from the setup flow). + +``` +Host * + IdentityAgent /Users/$YOUR_USERNAME/Library/Containers/com.maxgoedjen.Secretive.SecretAgent/Data/socket.ssh +``` + + +### The app I use isn't listed here! + +If you know how to get it set up, please open a PR for this page and add it! Contributions are very welcome. +If you're not able to get it working, please file a [GitHub issue](https://github.com/maxgoedjen/secretive/issues/new) for it. No guarantees we'll be able to get it working, but chances are someone else in the community might be able to. \ No newline at end of file diff --git a/FAQ.md b/FAQ.md index 990939b..1974c0d 100644 --- a/FAQ.md +++ b/FAQ.md @@ -4,20 +4,9 @@ The secure enclave doesn't allow import or export of private keys. For any new computer, you should just create a new set of keys. If you're using a smart card, you _might_ be able to export your private key from the vendor's software. -### Secretive doesn't work with my git client +### Secretive doesn't work with my git client/app -Secretive relies on the `SSH_AUTH_SOCK` environment variable being respected. The `git` and `ssh` command line tools natively respect this, but third party apps may require some configuration to work. A non-exhaustive list of clients is provided here: - -Tower - [Instructions](https://www.git-tower.com/help/mac/integration/environment) - -GitHub Desktop: Should just work, no configuration needed - -Fork - Add this to your `~/.ssh/config` (the path should match the socket path from the setup flow). - -``` -Host * - IdentityAgent /Users/$YOUR_USERNAME/Library/Containers/com.maxgoedjen.Secretive.SecretAgent/Data/socket.ssh -``` +Secretive relies on the `SSH_AUTH_SOCK` environment variable being respected. The `git` and `ssh` command line tools natively respect this, but third party apps may require some configuration to work. A non-exhaustive list of setup steps is provided in the [App Config FAQ](APP_CONFIG.md). ### Secretive isn't working for me