From 3ed89fded3a7787ce9e6d4ee7d8494d2181dfc06 Mon Sep 17 00:00:00 2001
From: medusa <newton214@gmail.com>
Date: Tue, 9 Jan 2024 07:23:13 +0000
Subject: [PATCH] Add docs/tech_docs/ssh-agent.md

---
 docs/tech_docs/ssh-agent.md | 64 +++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 docs/tech_docs/ssh-agent.md

diff --git a/docs/tech_docs/ssh-agent.md b/docs/tech_docs/ssh-agent.md
new file mode 100644
index 0000000..e3870e9
--- /dev/null
+++ b/docs/tech_docs/ssh-agent.md
@@ -0,0 +1,64 @@
+# Guide to Creating an SSH Agent and Alias
+
+Creating an SSH agent and setting up an alias simplifies the process of managing SSH keys, especially for keys with passphrases. Here's how to set it up on a Unix-like system.
+
+## Step 1: Starting the SSH Agent
+
+1. **Start the SSH Agent**:
+   Open your terminal and run:
+   ```bash
+   eval "$(ssh-agent -s)"
+   ```
+   This starts the SSH agent and sets the necessary environment variables.
+
+## Step 2: Adding Your SSH Key to the Agent
+
+1. **Add Your SSH Key**:
+   If you have a default SSH key, add it to the agent:
+   ```bash
+   ssh-add
+   ```
+   For a key with a different name or location, specify the path:
+   ```bash
+   ssh-add ~/.ssh/your_key_name
+   ```
+   Enter your passphrase when prompted.
+
+## Step 3: Creating an Alias for Starting the Agent
+
+1. **Edit Your Shell Profile**:
+   Depending on your shell, edit `~/.bashrc`, `~/.bash_profile`, or `~/.zshrc`:
+   ```bash
+   nano ~/.bashrc
+   ```
+
+2. **Add Alias**:
+   Add this line to your profile:
+   ```bash
+   alias startssh='eval "$(ssh-agent -s)" && ssh-add'
+   ```
+   Save and exit the editor.
+
+3. **Reload Your Profile**:
+   Apply the changes:
+   ```bash
+   source ~/.bashrc
+   ```
+   Or reopen your terminal.
+
+## Step 4: Using the Alias
+
+- **Start SSH Agent and Add Keys**:
+  Simply type in your terminal:
+  ```bash
+  startssh
+  ```
+  This command starts the SSH agent and adds your keys.
+
+## Additional Tips
+
+- **Automating the Process**: You can add the `eval` and `ssh-add` command directly to your profile for automation.
+- **SSH Agent Forwarding**: Use `-A` option with `ssh` for agent forwarding, but be cautious of security implications.
+- **Security Note**: Keep your private SSH keys secure and only add them to trusted machines.
+
+This guide outlines the steps for setting up an SSH agent and creating a convenient alias, making it easier to manage SSH keys with passphrases.