Skip to content

Commit

Permalink
updated rdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
rsalvado committed Sep 21, 2011
1 parent cfc6642 commit 996be8e
Showing 1 changed file with 31 additions and 25 deletions.
56 changes: 31 additions & 25 deletions README.rdoc
Expand Up @@ -8,38 +8,44 @@ You can configure several accounts, customize the action to run on the selected

Example yaml config file (~/.ec2ssh):

# YAML file with your account credentials and configuration for your accounts.
---
# Default account to use
:default:
:id: yourid
:key: yourkey
# Regions to check for running instances
:regions:
- us-east-1
# Another account, you can ec2ssh second
:second:
:id: yourid
:key: yourkey
:regions:
- eu-west-1
- us-east-1
# Command to run on selected instance. <instance> will be replaced by the selected instance hostname
:template: "ssh ec2-user@<instance> -i your-key.pem"
<code>
# YAML file with your account credentials and configuration for your accounts.
---
# Default account to use
:default:
:id: yourid
:key: yourkey
# Regions to check for running instances
:regions:
- us-east-1
# Another account, you can ec2ssh second
:second:
:id: yourid
:key: yourkey
:regions:
- eu-west-1
- us-east-1
# Command to run on selected instance. <instance> will be replaced by the selected instance hostname
:template: "ssh ec2-user@<instance> -i your-key.pem"
</code>

Invocation examples:

# Using the default account
ec2ssh
# To use the second account
ec2ssh second
<code>
# Using the default account
ec2ssh
# To use the second account
ec2ssh second
</code>

Example menu:

0. i-5e523428: gandalf webserver sysadmins ec2-79-165-69-177.eu-west-1.compute.amazonaws.com
1. i-5e653429: frodo database sysadmins ec2-45-134-69-185.eu-west-1.compute.amazonaws.com
<code>
0. i-5e523428: gandalf webserver sysadmins ec2-79-165-69-177.eu-west-1.compute.amazonaws.com
1. i-5e653429: frodo database sysadmins ec2-45-134-69-185.eu-west-1.compute.amazonaws.com
</code>

Columns in order: instance id, Name Tag, security groups, ssh key name, dns_name.
Columns in order: +instance id+, +Name Tag+, +security groups+, +ssh key name+, +dns_name+.

== Contributing to ec2ssh

Expand Down

0 comments on commit 996be8e

Please sign in to comment.