Egg Repository

Pterodactyl Community Egg Repository

Bun

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

Report an Issue!

Report an issue with this egg on GitHub using the buttons below

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 and Startup

Startup Command

if [[ -d .git ]] && [[ {{AUTO_UPDATE}} == "1" ]]; then git pull; fi; if [[ ! -z ${BUN_PACKAGES} ]]; then bun install ${BUN_PACKAGES}; fi; if [[ ! -z ${RMBUN_PACKAGES} ]]; then bun remove ${RMBUN_PACKAGES}; fi; if [ -f /home/container/package.json ]; then bun install; fi; bun run {{MAIN_FILE}}

Variables

Git Repository Address

The Git repository address to clone .

Environment Variable: GIT_ADDRESS
Default Value:
User Viewable:✅
User Editable:✅
User Uploaded Files

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

Environment Variable: USER_UPLOAD
Default Value: 0
User Viewable:✅
User Editable:✅
Auto Update

Pull the latest files on startup when using a Git Repository. 0 = false (default) 1 = true

Environment Variable: AUTO_UPDATE
Default Value: 0
User Viewable:✅
User Editable:✅
Main file

The main file passed to the bun run command

Environment Variable: MAIN_FILE
Default Value: index.js
User Viewable:✅
User Editable:✅
Additional Bun Packages

Install additional bun packages. Use spaces to separate

Environment Variable: BUN_PACKAGES
Default Value:
User Viewable:✅
User Editable:✅
Uninstall Bun Packages

Uninstall bun packages. Use spaces to separate

Environment Variable: RMBUN_PACKAGES
Default Value:
User Viewable:✅
User Editable:✅
Git Branch

The Git branch to install.

Environment Variable: BRANCH
Default Value:
User Viewable:✅
User Editable:✅
Git Username

Git username for authentication.

Environment Variable: USERNAME
Default Value:
User Viewable:✅
User Editable:✅
Git Access Token

Git access token for authentication.

Environment Variable: ACCESS_TOKEN
Default Value:
User Viewable:✅
User Editable:✅
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 "-----------------------------------------"
Installation Imageghcr.io/ptero-eggs/installers:debianInstallation Entrypointbash