Skip to content

nodemon

Nodemon javascript egg that automatically restarts the node application when file changes in the directory are detected This will clone a git repo for a bot. it defaults to master if no branch is specified. Installs the node_modules on install. If you set user_upload, then I assume you know what you are doing.

egg-nodemon.json

updated

Install

Installer image
node:lts-bookworm
Install script
68 lines

Images

New servers use the first image. Users can change it on the Startup page.

  • Nodejs 24 default ghcr.io/ptero-eggs/yolks:nodejs_24
  • Nodejs 23 ghcr.io/ptero-eggs/yolks:nodejs_23
  • Nodejs 22 ghcr.io/ptero-eggs/yolks:nodejs_22
  • Nodejs 21 ghcr.io/ptero-eggs/yolks:nodejs_21
  • Nodejs 20 ghcr.io/ptero-eggs/yolks:nodejs_20
  • Nodejs 19 ghcr.io/ptero-eggs/yolks:nodejs_19
  • Nodejs 18 ghcr.io/ptero-eggs/yolks:nodejs_18
  • Nodejs 17 ghcr.io/ptero-eggs/yolks:nodejs_17
  • Nodejs 16 ghcr.io/ptero-eggs/yolks:nodejs_16
  • Nodejs 14 ghcr.io/ptero-eggs/yolks:nodejs_14
  • Nodejs 12 ghcr.io/ptero-eggs/yolks:nodejs_12

Startup

The Panel runs this command to start the server. It replaces each variable in the command with the value of that variable.

9 variables

Startup command

npm install nodemon; if [[ -d .git ]] && [[ 0 == "1" ]]; then git pull; fi; if [[ ! -z {{NODE_PACKAGES}} ]]; then /usr/local/bin/npm install {{NODE_PACKAGES}}; fi; if [[ ! -z {{UNNODE_PACKAGES}} ]]; then /usr/local/bin/npm uninstall {{UNNODE_PACKAGES}}; fi; if [ -f /home/container/package.json ]; then /usr/local/bin/npm install --production; fi; /home/container/node_modules/nodemon/bin/nodemon.js /home/container/index.js
  • GitHub Repo to clone I.E. https://github.com/nickdevnl/repo_name

    GIT_ADDRESSUsers can edit

    nullable|string

  • The branch of the bot to install.

    BRANCHUsers can edit

    nullable|string

  • Skip all the install stuff if you are letting a user upload files. 0 = false (default) 1 = true

    USER_UPLOADUsers can edit

    required|boolean

  • Pull the latest files on startup when using a GitHub repo. You must have .git folder, reinstall if you are missing it.

    AUTO_UPDATEUsers can edit

    required|boolean

  • The file that starts the bot.

    BOT_JS_FILEUsers can edit

    required|string

  • Install additional node packages. Use spaces to separate.

    NODE_PACKAGESUsers can edit

    nullable|string

  • Uninstall node packages. Use spaces to separate.

    UNNODE_PACKAGESUsers can edit

    nullable|string

  • Username to auth with git.

    USERNAMEUsers can edit

    nullable|string

  • Password to use with git. It's best practice to use a Personal Access Token. https://github.com/settings/tokens https://gitlab.com/-/profile/personal_access_tokens

    ACCESS_TOKENUsers can edit

    nullable|string

Wings

Stop command
^C (SIGINT)
Running when the console shows
change this text

Readme

Nodemon (JavaScript & TypeScript)

Tired of manually restarting your bot? Nodemon will do it by itself.

Nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected. Nodemon does not require any additional changes to your code or method of development.

This egg is designed to run any generic Javascript application, allowing users to pull their own JavaScript or TypeScript source code from a Github repository.

There is an option to allow a user to upload their own files to run a bot.

The startup configs and commands may need changing to actually function properly.

Configuration

The server will be stuck as starting until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. image

You can use arrays to have multiple different values when different bots are being used

{
  "done":[
    "change this text 1",
    "change this text 2"
  ]
}

Changes

  1. Bump timestamps

    · Daniel Barton · 5aecb35

  2. egg(nodejs): add Node.js 23 & 24 to image list

    · lajczi · d6f34ea

  3. Fix docker image case

    · Daniel Barton · c6218f8

  4. Update repo names and remove some GH stuff for now

    · Daniel Barton · 8a5189b

  5. Append the forgotten commit

    · QuintenQVD0 · b047ae6

  6. change over for pelican-eggs layout

    · Michael (Parker) Parker · 9a21770

All changes on GitHub

Problem with this egg?

Open an issue on GitHub. Include your Panel and Wings versions.

Install script 68 lines bash in node:lts-bookworm Show
#!/bin/bash
# NodeJS Bot Installation Script
#
# Server Files: /mnt/server
apt update
apt install -y git curl jq file unzip make gcc g++ python python-dev libtool

mkdir -p /mnt/server
cd /mnt/server

if [ "${USER_UPLOAD}" == "true" ] || [ "${USER_UPLOAD}" == "1" ]; then
    echo -e "assuming user knows what they are doing have a good day."
    exit 0
fi

## add git ending if it's not on the address
if [[ ${GIT_ADDRESS} != *.git ]]; then
    GIT_ADDRESS=${GIT_ADDRESS}.git
fi

if [ -z "${USERNAME}" ] && [ -z "${ACCESS_TOKEN}" ]; then
    echo -e "using anon api call"
else
    GIT_ADDRESS="https://${USERNAME}:${ACCESS_TOKEN}@$(echo -e ${GIT_ADDRESS} | cut -d/ -f3-)"
fi

## pull git js bot repo
if [ "$(ls -A /mnt/server)" ]; then
    echo -e "/mnt/server directory is not empty."
    if [ -d .git ]; then
        echo -e ".git directory exists"
        if [ -f .git/config ]; then
            echo -e "loading info from git config"
            ORIGIN=$(git config --get remote.origin.url)
        else
            echo -e "files found with no git config"
            echo -e "closing out without touching things to not break anything"
            exit 10
        fi
    fi

    if [ "${ORIGIN}" == "${GIT_ADDRESS}" ]; then
        echo "pulling latest from github"
        git pull
    fi
else
    echo -e "/mnt/server is empty.\ncloning files into repo"
    if [ -z ${BRANCH} ]; then
        echo -e "cloning default branch"
        git clone ${GIT_ADDRESS} .
    else
        echo -e "cloning ${BRANCH}'"
        git clone --single-branch --branch ${BRANCH} ${GIT_ADDRESS} .
    fi

fi

echo "Installing nodejs packages"
if [[ ! -z ${NODE_PACKAGES} ]]; then
    /usr/local/bin/npm install ${NODE_PACKAGES}
fi

if [ -f /mnt/server/package.json ]; then
    /usr/local/bin/npm install --production
fi

echo -e "install complete"
exit 0