Skip to content

python generic

A Generic Python Egg for Pterodactyl Tested with: https://github.com/Ispira/pixel-bot

egg-python-generic.json

updated

Install

Installer image
python:3.8-slim-bookworm
Install script
70 lines

Images

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

  • Python 3.13 default ghcr.io/ptero-eggs/yolks:python_3.13
  • Python 3.12 ghcr.io/ptero-eggs/yolks:python_3.12
  • Python 3.11 ghcr.io/ptero-eggs/yolks:python_3.11
  • Python 3.10 ghcr.io/ptero-eggs/yolks:python_3.10
  • Python 3.9 ghcr.io/ptero-eggs/yolks:python_3.9
  • Python 3.8 ghcr.io/ptero-eggs/yolks:python_3.8
  • Python 3.7 ghcr.io/ptero-eggs/yolks:python_3.7
  • Python 2.7 ghcr.io/ptero-eggs/yolks:python_2.7

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

if [[ -d .git ]] && [[ "0" == "1" ]]; then git pull; fi; if [[ ! -z "{{PY_PACKAGES}}" ]]; then pip install -U --prefix .local {{PY_PACKAGES}}; fi; if [[ -f /home/container/requirements.txt ]]; then pip install -U --prefix .local -r requirements.txt; fi; /usr/local/bin/python /home/container/app.py
  • Git repo to clone I.E. https://github.com/parkervcp/repo_name

    GIT_ADDRESSUsers can edit

    nullable|string

  • What branch to pull from github. Default is blank to pull the repo default branch

    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.

    AUTO_UPDATEUsers can edit

    required|boolean

  • The file that starts the App.

    PY_FILEUsers can edit

    required|string

  • Install additional python packages. Use spaces to separate

    PY_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

  • if there are other requirements files to choose from.

    REQUIREMENTS_FILEUsers can edit

    required|string

Wings

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

Readme

Python Language Generic

This egg is designed to run any generic Python application, allowing users to pull their own Python 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. Python: Add 3.13

    · Daniel Barton · 8c21c84

  2. Fix docker image case

    · Daniel Barton · c6218f8

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

    · Daniel Barton · 8a5189b

  4. Append the forgotten commit

    · QuintenQVD0 · b047ae6

  5. change over for pelican-eggs layout

    · Michael (Parker) Parker · 9a21770

  6. feat(generic): expose python 3.12

    · jayceslesar · 7c4179c

All changes on GitHub

Problem with this egg?

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

Install script 70 lines bash in python:3.8-slim-bookworm Show
#!/bin/bash
# Python App Installation Script
#
# Server Files: /mnt/server
apt update
apt install -y git curl jq file unzip make gcc g++ 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 python 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

export HOME=/mnt/server

echo "Installing python requirements into folder"
if [[ ! -z ${PY_PACKAGES} ]]; then
    pip install -U --prefix .local ${PY_PACKAGES}
fi

if [ -f /mnt/server/requirements.txt ]; then
    pip install -U --prefix .local -r ${REQUIREMENTS_FILE}
fi

echo -e "install complete"
exit 0