https://github.com/muthuishere/deploygate
https://github.com/muthuishere/deploygate
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/muthuishere/deploygate
- Owner: muthuishere
- Created: 2024-02-24T06:01:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-20T16:58:47.000Z (about 1 year ago)
- Last Synced: 2025-02-06T16:59:05.487Z (3 months ago)
- Language: JavaScript
- Size: 190 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Deploy Gate
Deploy Gate is a tool to help you manage your self-hosted environment.
It is a Node.js based tool aimed at simplifying the complexities involved in setting up and maintaining self-hosted environments.
# Project Name
## Description
This project is a command-line interface (CLI) tool that helps manage your self-hosted environment. It provides functionalities to build a domain on a specific port, delete a domain, and deploy an application.
#### Pre-requisites
- Your Local machine has Ansible installed
- Install sshpass on your local machine for password authentication
```
## For Mac
brew install hudochenkov/sshpass/sshpass
## For Ubuntu
sudo apt-get install sshpass
```
- Your local machine has Docker installed with Docker Compose
- Your local machine has a jq installed
- your local machine has an alias for the remote machine , so that you can access the remote machine with a single command
- Make sure you have a domain name configured with NGINX
- Your Target domain is on Ubuntu
- Your Target domain can be accessed via SSH wia passwordless login
- Your Target domain has Docker and Docker Compose installed
- Your Target domain has certbot installed
- Your Target domain has a domain name configured with NGINX
## Installation
To install this CLI tool, run the following command:
```bash
npm install -g deploy-gate
```
## Usage
### Initialize App Config
To set a app config, use the following command:
```bash
deploy-gate init-config
```
### Update App Config
To update app config, use the following command:
```bash
deploy-gate update-config
```
### Remove App config
To remove app config
```shell
deploy-gate remove-config
```
### Build Domain on Port
To build a domain on a specific port, use the following command:
```bash
deploy-gate create_domain --domainName --redirectPort --enableSSL
```
### Delete Domain
To delete a domain, use the following command:
```bash
deploy-gate delete-domain --domainName
```
### Deploy App
To deploy an application, use the following command:
```bash
deploy-gate deploy-app --port --dockerfile --env
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)