https://github.com/activecampaign/aws-ssh-helper
Generates SSH configuration from EC2 metadata
https://github.com/activecampaign/aws-ssh-helper
Last synced: about 1 year ago
JSON representation
Generates SSH configuration from EC2 metadata
- Host: GitHub
- URL: https://github.com/activecampaign/aws-ssh-helper
- Owner: ActiveCampaign
- License: mit
- Created: 2018-07-15T18:45:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-06T20:05:29.000Z (almost 8 years ago)
- Last Synced: 2025-04-01T16:09:26.925Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 1.79 MB
- Stars: 3
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
AWS SSH Helper
==============
This tool makes SSH configuration from AWS EC2 metadata. It depends on
[assh](https://github.com/moul/advanced-ssh-config).
Requirements
------------
* PHP 7.1+
Installation
------------
```sh
$ curl -sO https://activecampaign.github.io/aws-ssh-helper/downloads/aws-ssh-helper.phar
$ chmod +x aws-ssh-helper.phar
```
Usage
-----
If you have resources in two regions -- us-east1 and us-west-1 -- and
two accounts/profiles, you'd run:
```bash
aws-ssh-helper.phar --profile=production --region=us-east-1 > ~/.ssh/assh.d/bangpound-production-us-east-1.yaml
aws-ssh-helper.phar --profile=production --region=us-west-1 > ~/.ssh/assh.d/bangpound-production-us-west-1.yaml
aws-ssh-helper.phar --profile=staging --region=us-east-1 --prefix=stg- > ~/.ssh/assh.d/bangpound-staging-us-east-1.yaml
aws-ssh-helper.phar --profile=staging --region=us-west-1 --prefix=stg- > ~/.ssh/assh.d/bangpound-staging-us-west-1.yaml
```
* Instance ID is used as the unique hostname.
* Name tag, public IP, public hostname, private IP and private
hostname are aliases for each host. If there is duplication of aliases
for multiple host configurations, the behavior when using that alias
is not defined.
* For instances in a private subnet, an instance in the same VPC with
`bastion` in its name will be used as a proxy.
* The default login user is `ec2-user`. If an instance has a tag
`LoginUser`, its value will be used instead.