Skip to content

chore: bump minimum node version #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"license": "MIT",
"packageManager": "[email protected]",
"engines": {
"node": ">=16.0.0"
"node": ">=18.0.0"
},
"repository": {
"type": "git",
Expand All @@ -34,7 +34,7 @@
"preinstall": "npx only-allow pnpm"
},
"dependencies": {
"commander": "^11.1.0",
"commander": "^12.0.0",
"shelljs": "~0.8.5"
},
"devDependencies": {
Expand Down
12 changes: 6 additions & 6 deletions cli/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 9 additions & 3 deletions docs/cli/github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ In order to login to your linux server, you need to add your user credentials as

Inside your git repository, create a `.github/workflows/deploy.yml` file and add the following content:

:::tip CLI version
We recommend to specify the major version of the CLI to use (e.g. `npx nginx-proxy-cli@3`).
Otherwise, breaking changes we make to the CLI might break your existing GitHub actions.
:::

```yaml
name: Deploy
on:
Expand All @@ -35,15 +40,16 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout Git repository
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Deploy
uses: appleboy/ssh-action@master
uses: appleboy/ssh-action@1.0.3
with:
host: ${{ secrets.SSH_HOST }}
username: ${{ secrets.SSH_USERNAME }}
password: ${{ secrets.SSH_PASSWORD }}
envs: GITHUB_SERVER_URL,GITHUB_REPOSITORY
script: npx nginx-proxy-cli deploy $GITHUB_SERVER_URL/$GITHUB_REPOSITORY --dir=~/nginx-proxy/applications
script: npx nginx-proxy-cli@3 deploy $GITHUB_SERVER_URL/$GITHUB_REPOSITORY --dir=~/nginx-proxy/applications
```

**Notes**:
Expand Down
21 changes: 7 additions & 14 deletions docs/cli/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,22 @@ The `nginx-proxy` offers a Node CLI that can be used to e.g. simplify or automat

## Prerequisites

You need to have node installed on your system when you want to use the CLI.
You need to have [Node.js](https://nodejs.org) `>= 18` installed on your system when you want to use the CLI.

### Install node

- **Step 1:** Get installation script with (replacing `16.x` with the version that you want to install):
We recommend to install node using [fnm](https://github.com/Schniz/fnm).

```bash
curl -sL https://deb.nodesource.com/setup_16.x -o nodesource_setup.sh
```

- **Step 2:** Execute the script with:

```bash
bash nodesource_setup.sh
```
- **Step 1:** Follow the [fnm installation instructions](https://github.com/Schniz/fnm?tab=readme-ov-file#installation)

- **Step 3:** Install node
- **Step 2:** Install your desired node version

```bash
apt install nodejs
fnm install 20
fnm default 20
```

- **Step 4 (optional):** Check node version
- **Step 3 (optional):** Verify installation

```bash
node -v
Expand Down