This repository has been archived by the owner on Jan 14, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Added instructions for the cheat.sh deployment #41
Open
sahil-shubham
wants to merge
1
commit into
master
Choose a base branch
from
cheat-sh-deployment
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
## Cheat.sh deployment | ||
|
||
Our [cheat.sh](https://github.com/felvin-search/cheat.sh) app can be useful in answering tons of queries regarding simple commands. We have deployed our fork of the repository on a `EC2 t2.small` instance. | ||
|
||
### How is it deployed? | ||
- The main branch of the repository is cloned in the above mentioned ec2 instance | ||
- Go inside the cloned folder | ||
|
||
``` | ||
cd cheat.sh | ||
``` | ||
|
||
- `docker-compose` is used to deploy containers of a flask server and a reddis image. | ||
|
||
``` | ||
docker-compose up -d | ||
``` | ||
|
||
`-d` is for detached mode, so that the command exits once the deployment is up. | ||
|
||
- If there are changes to nginx config, just run the following to restart nginx: | ||
|
||
``` | ||
sudo systemctl restart nginx | ||
``` | ||
|
||
### How do you deploy a new version then? | ||
- Deploying a new version is just making a new image with the newest file changes | ||
- Hence, just bring down the containers: | ||
|
||
``` | ||
docker-compose down | ||
``` | ||
|
||
- Get the latest changes using git for whichever branch needed (preferabbly only main should be kept for deployment) | ||
- Start the containers back again, new images would be built depending on the changes and containers would be setup | ||
|
||
``` | ||
docker-compose up -d | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sahil-shubham is it possible to automate this part through an actions script?