diff --git a/README.md b/README.md index 58aa4f0..35eb0f8 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,14 @@ - -![rabbitory logo](https://raw.githubusercontent.com/your-username/rabbitory/main/assets/rabbitory-logo.png) + +rabbitory-logo + + +# Rabbitory CLI [![npm version](https://img.shields.io/npm/v/rabbitory_cli)](https://www.npmjs.com/package/rabbitory_cli) -# Rabbitory CLI +Rabbitory command-line interface (CLI) streamlines the deployment of the Rabbitory Control Panel infrastructure on AWS. You can effortlessly integrate with your AWS environment and automatically provision the resources needed to manage your RabbitMQ instances on the Cloud. -**Rabbitory CLI** is a command-line interface tool designed to streamline the deployment of the Rabbitory Control Panel infrastructure on AWS. With Rabbitory CLI, you can effortlessly integrate with your AWS environment and automatically provision the resources needed to manage your RabbitMQ instances on the Cloud. - -- [Rabbitory CLI](#rabbitory-cli) - - [🛠 Features](#🛠-features) - - [Seamless AWS Integration](#seamless-aws-integration) - - [Deployment Automation](#deployment-automation) - - [Automated Rollback](#automated-rollback) - - [📦 Installation](#📦-installation) - - [Prerequisites](#prerequisites) - - [Installing Rabbitory CLI](#installing-rabbitory-cli) - - [🐰 Usage](#🐰-usage) - - [Deploying Rabbitory](#deploying-rabbitory) - - [Custom Domain Setup](#custom-domain-setup) - - [Tearing down Rabbitory](#tearing-down-rabbitory) +For information ## 🛠 Features @@ -60,7 +50,6 @@ Once your AWS credentials are set up, you can install the Rabbitory CLI by runni ``` npm install rabbitory_cli -g - ``` --- @@ -78,19 +67,18 @@ rabbitory deploy After entering this command, you'll be prompted to enter your preferred AWS global region, then your preferred AWS region code.

- select-global-region -

-

- select-aws-region + select-region-code

Now that a region has been selected, you'll be prompted to choose between deploying to the default public IP address provided by AWS or providing your own custom domain. See next section for more information on custom domain setup. Upon deployment, Rabbitory spins up all the necessary AWS infrastructure for you to self-host your personal Rabbitory Control Panel, where you can create, configure, and manage your RabbitMQ instances. Once Rabbitory has been successfully deployed, you'll receive a link to your Control Panel. -![Deploy success](https://raw.githubusercontent.com/Rabbitory/rabbitory_cli/assets/rabbitory-deploy-success.png) +

+ deploy-success +

-#### Custom Domain Setup +### Custom Domain Setup Using a custom domain provides secure HTTPS access and a professional URL for your Control Panel. If you choose the default public IP option, the Control Panel will only be accessible via HTTP. @@ -100,6 +88,13 @@ If you opt to use a custom domain, you’ll be prompted to provide your domain n - Set up SSL certificates using Let's Encrypt - Configure Nginx with HTTPS +

+ select-http-or-https +

+

+ provide-custom-domain +

+ Your Rabbitory Control Panel will then be accessible via HTTPS at both your apex domain () and www subdomain (). ### Tearing down Rabbitory @@ -113,7 +108,7 @@ rabbitory destroy Tearing down Rabbitory involves selecting the global region and AWS region code where your Rabbitory Control Panel was initially deployed. Then, all AWS resources that were created will be automatically deleted for you, leaving you with a clean AWS environment.

- select-aws-region + destroy-success

--- diff --git a/assets/deploy-success.png b/assets/deploy-success.png index a03613e..fdec4e1 100644 Binary files a/assets/deploy-success.png and b/assets/deploy-success.png differ diff --git a/assets/destroy-success.png b/assets/destroy-success.png index edc924f..50b83a8 100644 Binary files a/assets/destroy-success.png and b/assets/destroy-success.png differ diff --git a/assets/provide-custom-domain.png b/assets/provide-custom-domain.png index 38cf4d5..c5cfac8 100644 Binary files a/assets/provide-custom-domain.png and b/assets/provide-custom-domain.png differ diff --git a/assets/select-http-or-https.png b/assets/select-http-or-https.png index 5d49d46..151dc19 100644 Binary files a/assets/select-http-or-https.png and b/assets/select-http-or-https.png differ