update README for automated SSH key generation

Update README to reflect that SSH keys are now automatically generated and can't be imported or edited manually.

- Remove outdated key structure documentation
- Simplify initial setup instructions
- Add note about public key deployment
This commit is contained in:
Oli
2024-12-14 00:53:20 +01:00
parent c8f75649af
commit 24642aa40b

View File

@@ -19,19 +19,12 @@ Download the script file (`vaultwarden-ssh-agent.ps1`) to your preferred locatio
### Initial Setup ### Initial Setup
- Create a folder (default name: 'ssh-agent') in your Vaultwarden vault - Create a folder (default name: 'ssh-agent') in your Vaultwarden vault
- Create a new item in the 'ssh-agent' folder - Create a new SSH Key item in the folder by selecting "SSH Key" as the type
- Paste the public key in the notes field - An ED25519 key pair will be automatically generated
- Attach the private key as a file attachment - If you need different keys, you can use the refresh button to generate a new pair
- Note: The key generation is managed by Bitwarden Client and cannot be edited manually
Note: If you haven't configured the Bitwarden CLI for your Vaultwarden instance yet, don't worry! The script will automatically prompt you for your server URL during the first run. - Save the item
- Deploy the generated public key to systems where you need access
### Key Item Structure
Each SSH key in Vaultwarden should be structured as follows:
- Folder: Must be in the 'ssh-agent' folder (or your custom folder name)
- Name: A descriptive name for your SSH key
- Notes: Contains the public key (required)
- Attachment: The private key file (required)
## Usage ## Usage
### Basic usage ### Basic usage
@@ -83,9 +76,8 @@ Start-Service ssh-agent
**"Failed to add key"** **"Failed to add key"**
- Verify the SSH agent is running - Verify the SSH agent is running
- Check key format in Vaultwarden - Check entries in the created folder in your Vaultwarden vault
- Run with -Debug flag for more information - Run with -Debug flag for more information
- Verify private key file attachment
**"Bitwarden CLI not found"** **"Bitwarden CLI not found"**
- Ensure Bitwarden CLI is installed - Ensure Bitwarden CLI is installed