https://github.com/arnav-kr/nest-deploy

A Utility for Deploying Docker Containers to Nest Instance
https://github.com/arnav-kr/nest-deploy

arnav arnav-kr hackclub nest nest-instance vps

Last synced: 25 days ago
JSON representation

A Utility for Deploying Docker Containers to Nest Instance

• Host: GitHub
• URL: https://github.com/arnav-kr/nest-deploy
• Owner: arnav-kr
• License: agpl-3.0
• Created: 2024-08-17T07:52:25.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-20T18:41:56.000Z (3 months ago)
• Last Synced: 2024-09-28T01:40:57.839Z (about 1 month ago)
• Topics: arnav, arnav-kr, hackclub, nest, nest-instance, vps
• Language: JavaScript
• Homepage:
• Size: 487 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# nest-deploy

A Utility for Deploying Docker Containers to Nest Instance

[![GitHub](https://img.shields.io/github/license/arnav-kr/nest-deploy?style=flat-square&logo=github&logoColor=white&label=GitHub&labelColor=%233d3d3d&color=%234285F4)](https://github.com/arnav-kr/nest-deploy)

## Setup

### On Nest

```sh

git clone https://github.com/arnav-kr/nest-deploy

cd nest-deploy

node ./nest-deploy.js setup

```

The setup script will add a `deploy` subdomain entry to `~/Caddyfile`, create a `systemd` service (`~/.config/systemd/user/nest-deploy.service`), enable and start the service

#### Add a project using the nest-deploy cli

```sh

node ./nest-deploy.js project add 

```

it will add a project entry in `./projects.json` file

#### list all the projects

```sh

node ./nest-deploy.js project list

```

Note down the `Deploy URL` and `Deploy Token` of your project,

> [!IMPORTANT]

> Deploy Token is meant to be confidential

### On GitHub Repo

1. copy the [.github/workflows/nest.yml](https://github.com/arnav-kr/nest-deploy/blob/main/.github/workflows/nest.yml) file to your repo

2. in the environment settings of repo add the `DEPLOY_URL` and `DEPLOY_TOKEN` of your project in environment secrets of `nest` environment

3. the deploy action will run whenever code is pushed to main branch and restart the project container running on the nest instance with the latest changes.

#### Run respective help commands of the cli for more info

```sh

node ./nest-deploy.js help

```

```sh

node ./nest-deploy.js project help

```

## Author

Arnav Kumar [@arnav-kr](https://github.com/arnav-kr)

## LICENSE

[AGPL-3.0](https://github.com/arnav-kr/nest-deploy/blob/main/LICENSE)