Skip to content

Commit 44ee0f2

Browse files
author
sandesh.tamang
committed
fix: keys path and config and Readme.md modified
1 parent 9505338 commit 44ee0f2

8 files changed

Lines changed: 244 additions & 93 deletions

File tree

.github/workflows/release.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ on:
4545
jobs:
4646
# Run 'cargo dist plan' (or host) to determine what tasks we need to do
4747
plan:
48-
runs-on: "ubuntu-20.04"
48+
runs-on: "ubuntu-latest"
4949
outputs:
5050
val: ${{ steps.plan.outputs.manifest }}
5151
tag: ${{ !github.event.pull_request && github.ref_name || '' }}
@@ -158,7 +158,7 @@ jobs:
158158
needs:
159159
- plan
160160
- build-local-artifacts
161-
runs-on: "ubuntu-20.04"
161+
runs-on: "ubuntu-latest"
162162
env:
163163
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
164164
BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json
@@ -208,7 +208,7 @@ jobs:
208208
if: ${{ always() && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }}
209209
env:
210210
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
211-
runs-on: "ubuntu-20.04"
211+
runs-on: "ubuntu-latest"
212212
outputs:
213213
val: ${{ steps.host.outputs.manifest }}
214214
steps:
@@ -272,7 +272,7 @@ jobs:
272272
# still allowing individual publish jobs to skip themselves (for prereleases).
273273
# "host" however must run to completion, no skipping allowed!
274274
if: ${{ always() && needs.host.result == 'success' }}
275-
runs-on: "ubuntu-20.04"
275+
runs-on: "ubuntu-latest"
276276
env:
277277
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
278278
steps:

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "e2s"
3-
version = "0.0.3"
3+
version = "0.1.0"
44
edition = "2021"
55

66
# Github Repo

README.md

Lines changed: 1 addition & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -14,84 +14,7 @@ A blazingly fast Terminal User Interface (TUI) for managing AWS EC2 instances, b
1414
-**Fast & Lightweight** - Built with Rust for optimal performance
1515

1616
## 📦 Installation
17-
18-
### Linux & macOS
19-
20-
```bash
21-
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/sandeshgrangdan/e2s/releases/download/v0.0.3/e2s-installer.sh | sh
22-
```
23-
24-
### Windows
25-
26-
```powershell
27-
powershell -c "irm https://github.com/sandeshgrangdan/e2s/releases/download/v0.0.3/e2s-installer.ps1 | iex"
28-
```
29-
30-
## 🔧 Prerequisites
31-
32-
Before using EC2 TUI, ensure you have:
33-
34-
1. **SSH Keys Setup** - Your SSH keys must be configured in `~/.ssh/` directory
35-
2. **AWS Credentials** - Valid AWS credentials configured (via AWS CLI or environment variables)
36-
3. **Network Access** - Ability to reach your EC2 instances via SSH
37-
38-
## ⚙️ [Optional] Configuration
39-
40-
EC2 TUI uses a TOML configuration file located at `~/.config/e2s/config.toml`.
41-
42-
### Example Configuration
43-
44-
```toml
45-
[users]
46-
# Default user - will be auto-selected when app starts
47-
# If not specified, the first user in the list will be selected
48-
default_user = "ubuntu"
49-
50-
# Additional SSH users for different EC2 instances
51-
# Common users for different Linux distributions:
52-
# - Amazon Linux: ec2-user
53-
# - Ubuntu: ubuntu
54-
# - Debian: admin or debian
55-
# - CentOS/RHEL: centos or ec2-user
56-
# - Rocky Linux: rocky
57-
additional_users = [
58-
"admin",
59-
"root",
60-
"centos",
61-
"debian",
62-
"fedora",
63-
"rocky",
64-
"azureuser", # For Azure VMs
65-
"bitnami", # For Bitnami instances
66-
]
67-
```
68-
69-
### Configuration Options
70-
71-
- **`default_user`** - The SSH user that will be pre-selected when the application starts
72-
- **`additional_users`** - List of additional SSH users to choose from when connecting to instances
73-
74-
## 🎯 Usage
75-
76-
Simply run the command:
77-
78-
```bash
79-
ec2
80-
```
81-
82-
The TUI will launch and display all your EC2 instances. Navigate through the list and select an instance to SSH into it.
83-
84-
## 🗺️ Common SSH Users by Distribution
85-
86-
| Distribution | Default User |
87-
|-------------|--------------|
88-
| Amazon Linux | `ec2-user` |
89-
| Ubuntu | `ubuntu` |
90-
| Debian | `admin` or `debian` |
91-
| CentOS/RHEL | `centos` or `ec2-user` |
92-
| Rocky Linux | `rocky` |
93-
| Fedora | `fedora` |
94-
| Bitnami AMIs | `bitnami` |
17+
[Documentation](https://github.com/samdeshgrangdan/e2s/USAGES.md)
9518

9619
## 🤝 Contributing
9720

USAGES.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
## 📦 Installation
2+
3+
### Linux & macOS
4+
5+
```bash
6+
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/sandeshgrangdan/e2s/releases/download/v0.1.0/e2s-installer.sh | sh
7+
```
8+
9+
### Windows
10+
11+
```powershell
12+
powershell -c "irm https://github.com/sandeshgrangdan/e2s/releases/download/v0.1.0/e2s-installer.ps1 | iex"
13+
```
14+
15+
### Cargo
16+
17+
```bash
18+
cargo install e2s
19+
```
20+
21+
## 🔧 Prerequisites
22+
23+
Before using EC2 TUI, ensure you have:
24+
25+
1. **SSH Keys Setup** - Your SSH keys must be configured in `~/.ssh/` directory
26+
2. **AWS Credentials** - Valid AWS credentials configured (via AWS CLI or environment variables)
27+
3. **Network Access** - Ability to reach your EC2 instances via SSH
28+
29+
## ⚙️ [Optional] Configuration
30+
31+
EC2 TUI uses a TOML configuration file located at `~/.config/e2s/config.toml`.
32+
33+
### Example Configuration
34+
35+
```toml
36+
[users]
37+
# Default user - will be auto-selected when app starts
38+
# If not specified, the first user in the list will be selected
39+
default_user = "ubuntu"
40+
41+
# Additional SSH users for different EC2 instances
42+
# Common users for different Linux distributions:
43+
# - Amazon Linux: ec2-user
44+
# - Ubuntu: ubuntu
45+
# - Debian: admin or debian
46+
# - CentOS/RHEL: centos or ec2-user
47+
# - Rocky Linux: rocky
48+
additional_users = [
49+
"admin",
50+
"root",
51+
"centos",
52+
"debian",
53+
"fedora",
54+
"rocky",
55+
"azureuser", # For Azure VMs
56+
"bitnami", # For Bitnami instances
57+
]
58+
59+
[keys]
60+
# Use just the filename if the key is in ~/.ssh/
61+
default_key = "dev-key.pem"
62+
# OR use the full path:
63+
# default_key = "/home/sandesh/.ssh/eclat-dev1.pem"
64+
65+
# Additional keys from other locations (optional)
66+
additional_keys = [
67+
"/home/sandesh/custom/another_key.pem",
68+
"~/Documents/keys/work_key"
69+
]
70+
```
71+
72+
### Configuration Options
73+
74+
- **`default_user`** - The SSH user that will be pre-selected when the application starts
75+
- **`additional_users`** - List of additional SSH users to choose from when connecting to instances
76+
77+
## 🎯 Usage
78+
79+
Simply run the command:
80+
81+
```bash
82+
e2s
83+
```
84+
85+
The TUI will launch and display all your EC2 instances. Navigate through the list and select an instance to SSH into it.
86+
87+
## 🗺️ Common SSH Users by Distribution
88+
89+
| Distribution | Default User |
90+
|-------------|--------------|
91+
| Amazon Linux | `ec2-user` |
92+
| Ubuntu | `ubuntu` |
93+
| Debian | `admin` or `debian` |
94+
| CentOS/RHEL | `centos` or `ec2-user` |
95+
| Rocky Linux | `rocky` |
96+
| Fedora | `fedora` |
97+
| Bitnami AMIs | `bitnami` |

0 commit comments

Comments
 (0)