Egg Repository

Pterodactyl Community Egg Repository

Bun

Bun is an incredibly fast JavaScript runtime, transpiler bundler, and npm package manager all-in-one.

Read Me

Bun - JavaScript & TypeScript Generic

From their site

This egg is designed to run any generic Bun application, allowing users to pull their own Bun source code from a Git repository.

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

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"
  ]
}
Yolks
NameTag
Bun Latestghcr.io/ptero-eggs/yolks:bun_latest
Bun Canaryghcr.io/ptero-eggs/yolks:bun_canary
Variables
NameDescriptionEnvironment VariableDefault ValueUser ViewableUser Editable
Git Repository AddressThe Git repository address to clone .GIT_ADDRESSYesYes
User Uploaded FilesSkip all the install stuff if you are letting a user upload files. 0 = false (default) 1 = trueUSER_UPLOAD0YesYes
Auto UpdatePull the latest files on startup when using a Git Repository. 0 = false (default) 1 = trueAUTO_UPDATE0YesYes
Main fileThe main file passed to the bun run commandMAIN_FILEindex.jsYesYes
Additional Bun PackagesInstall additional bun packages. Use spaces to separateBUN_PACKAGESYesYes
Uninstall Bun PackagesUninstall bun packages. Use spaces to separateRMBUN_PACKAGESYesYes
Git BranchThe Git branch to install.BRANCHYesYes
Git UsernameGit username for authentication.USERNAMEYesYes
Git Access TokenGit access token for authentication.ACCESS_TOKENYesYes
Install Script
#!/bin/bash
# Bun App 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


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 bun packages"
if [[ ! -z ${BUN_PACKAGES} ]]; then
    bun install ${BUN_PACKAGES}
fi

if [ -f /mnt/server/package.json ]; then
    bun install --production
fi

## install end
echo "-----------------------------------------"
echo "Installation completed..."
echo "-----------------------------------------"