Giter Club home page Giter Club logo

sssh's Introduction

sssh: Simplified SSH for Amazon ECS Fargate

sssh is a Bash script designed to streamline the process of using ecs-exec to execute commands in Amazon ECS Fargate containers. It provides an interactive experience for selecting ECS profiles, clusters, services, containers, and tasks to run shell commands or port forwarding.

This is an actively maintained fork of the original sssh project. Contributions and feedback are welcome!

Table of Contents

  1. Prerequisites
  2. Installation
  3. Usage
  4. Contributing
  5. Special Thanks
  6. License

Prerequisites

Note: Ensure that your AWS CLI session profile is set to output in JSON format before running the script. This is crucial as the script may not function correctly otherwise. You can set the output format to JSON by executing aws configure sso.

Installation

To install sssh, clone the repository and run the script as follows:

git clone https://github.com/your-username/sssh.git
cd sssh
./sssh

Usage

sssh simplifies the process of connecting to your Amazon ECS Fargate containers. Here is how you can leverage its functionality:

Interactive Shell:

# Launch an interactive shell within your selected ECS container.
# The script will guide you through a series of prompts to select the appropriate
# AWS profile, cluster, service, container, and task.
  ./sssh

Port Forwarding:

# Set up port forwarding from your local machine to a remote service via the
# selected container. You'll need to provide the remote host's address, the
# remote port, and a local port to forward to.
./sssh --remote-host rds.example.com --remote-port 3306 --local-port 13306

Getting Help:

# Display the help information for additional context and command usage.
./sssh --help

Contributing

This fork of sssh is actively maintained. Contributions are welcome and greatly appreciated! If you have a feature request, a bug to report, or a patch that you would like to contribute, please feel free to raise an issue or open a pull request. We aim to foster an inclusive and welcoming community around improving and extending this tool.

Special Thanks

Special thanks to the authors and original contributors:

License

This project is a fork of sssh originally created by Yuki Adachi. It is licensed under the Apache License, Version 2.0. This fork is being actively maintained and may include modifications not present in the original repository. For details on changes made, please see the commit history.

sssh's People

Contributors

bamkuhen avatar florianfelsing avatar yuki777 avatar

Stargazers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.