Files
mcp-ssh-orchestrator/examples/example-credentials.yml
T

46 lines
1.5 KiB
YAML

# example-credentials.yml
#
# Example SSH credentials configuration for mcp-ssh-orchestrator.
# Copy this to config/credentials.yml and customize for your environment.
#
# SECURITY NOTES:
# - Never commit real secrets to Git
# - Use Docker secrets or environment variables for passwords/passphrases
# - Keep SSH private keys in /app/keys (mounted read-only)
# - Set key file permissions to 0400 (read-only for owner)
#
# Fields:
# name: unique identifier referenced by servers.yml (required)
# username: SSH username (required)
# key_path: path to private key file relative to /app/keys or absolute path
# password_secret: name of secret/env var containing password (for password auth)
# key_passphrase_secret: name of secret/env var containing key passphrase
#
# Secret resolution order:
# 1. Environment variable: MCP_SSH_SECRET_<NAME> (uppercase)
# 2. Docker secret file: /app/secrets/<name>
entries:
- name: "default"
username: "ubuntu"
key_path: "id_ed25519"
key_passphrase_secret: ""
password_secret: ""
- name: "staging"
username: "deploy"
key_path: "id_rsa"
key_passphrase_secret: "staging_key_passphrase"
password_secret: ""
- name: "password_example"
username: "admin"
key_path: ""
key_passphrase_secret: ""
password_secret: "admin_password"
- name: "encrypted_key_example"
username: "deploy"
key_path: "id_rsa_encrypted"
key_passphrase_secret: "key_passphrase"
password_secret: ""