Compare commits

...
5 Commits
Author SHA1 Message Date
Nyo ef770cdd40 Add NodeJS 22 and 24 to docker images 2026-04-20 16:17:41 +02:00
Nyo 043e81e380 Update README.md 2025-05-22 20:07:05 +02:00
1tzEmerald 6bddeb61ed Update egg-support-bot.json 2024-11-05 19:57:37 +00:00
ItsNyoty 4e4f585088 Update egg-support-bot.json
V8 ready
2024-06-12 14:48:01 +02:00
1tzEmerald b549d7bbe7 Update egg-support-bot.json 2022-07-24 12:34:26 +01:00
2 changed files with 68 additions and 16 deletions

No files matched your search

+50 -2
View File
@@ -1,2 +1,50 @@
# Pterodactyl-Egg
Pterodactyl Egg for SupportBot
# Pterodactyl Egg for SupportBot by EmeraldSRV
This repository contains a Pterodactyl egg for deploying [SupportBot](https://github.com/Emerald-Services/SupportBot) on your Pterodactyl panel.
## What is SupportBot?
SupportBot is an Open-Source discord bot built with [discord.js](https://github.com/discordjs/discord.js). It's primarily focused to help servers organise and manage their support system in a unique way with full customisation to match your brand.
## Features of this Egg
* **Simple Deployment:** Easily deploy SupportBot with minimal configuration.
* **Automatic Dependency Installation:** The egg automatically installs all required dependencies.
* **Configuration File Management:** Includes a basic configuration file with placeholders for your Discord bot token, and other essential settings.
* **Automatic Start-up:** Ensures SupportBot starts automatically after deployment.
## Requirements
* A Pterodactyl panel running version 1.0 or higher.
* A Discord bot token.
* Node.js version 20 or higher installed on your Pterodactyl server node.
* Sufficient resources allocated to the server (RAM, CPU, Disk Space). The recommended resource allocation will depend on the size and activity of your Discord server. Start with a minimum of 512MB RAM and 1 vCPU.
## Installation
1. **Download the Egg:** Download the `egg-support-bot.json` file from this repository.
2. **Import the Egg:**
* Log in to your Pterodactyl panel as an administrator.
* Navigate to "Nests" and select the nest you want to add the SupportBot egg to (e.g., "Discord Bots").
* Click "Import Egg" and upload the `egg-support-bot.json` file.
3. **Create a Server:**
* Create a new server within the nest you imported the egg into.
* Select the "SupportBot" egg.
* Configure the server settings according to your needs (RAM, CPU, Disk Space, etc.).
4. **Configure the Startup Command:** (Optional, but recommended)
* On the Server Settings page, make sure the "Startup Command" is set to the standard command. This command tells the server how to start your bot.
5. **Install the Bot:**
* Start the server. This will automatically install the necessary dependencies.
* Check the server console for any errors.
6. **Configure the Bot:**
* Access the server's file manager.
* Edit the `Configs\supportboy.yml` file. **This is crucial!**
* Replace the placeholders with your Discord bot token, prefix, and other relevant settings.
* **Save the configuration file.**
7. **Start the Bot:**
* Restart the server. This will start your SupportBot.
* Invite your bot to your Discord server using the appropriate bot invite link. (You can find information on generating invite links on the Discord Developer Portal.)
## Documentation
You can find the documentation of the bot [here](https://docs.emeraldsrv.com/bots/supportbot/configuration)
+18 -14
View File
@@ -1,42 +1,46 @@
{
"_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
"meta": {
"version": "PTDL_v1",
"version": "PTDL_v2",
"update_url": null
},
"exported_at": "2021-10-29T01:55:51+01:00",
"exported_at": "2024-06-12T14:43:25+02:00",
"name": "SupportBot",
"author": "noah@n0ahmc.com",
"author": "me@1tzemerald.com",
"description": "Installs the latest release of SupportBot from Github",
"features": null,
"images": [
"ghcr.io\/parkervcp\/yolks:nodejs_17",
"ghcr.io\/parkervcp\/yolks:nodejs_16"
],
"docker_images": {
"NodeJS 20 ": " ghcr.io\/parkervcp\/yolks:nodejs_20",
"NodeJS 21 ": " ghcr.io\/parkervcp\/yolks:nodejs_21",
"NodeJS 22 ": " ghcr.io\/parkervcp\/yolks:nodejs_22",
"NodeJS 24 ": " ghcr.io\/parkervcp\/yolks:nodejs_24"
},
"file_denylist": [],
"startup": "if [ -d .git ]; then git pull; fi; if [ -f \/home\/container\/package.json ]; then \/usr\/local\/bin\/npm start; fi;",
"config": {
"files": "{}",
"startup": "{\r\n \"done\": \"SupportBot proudly created by Emerald Services\"\r\n}",
"startup": "{\r\n \"done\": \"SupportBot proudly created by Emerald Development\"\r\n}",
"logs": "{}",
"stop": "^^C"
},
"scripts": {
"installation": {
"script": "#!\/bin\/bash\r\n# SupportBot Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\necho -e \"${BETA}\"\r\napt update\r\napt install -y git curl jq file unzip make gcc g++ python python-dev libtool\r\n\r\nmkdir -p \/mnt\/server\r\ncd \/mnt\/server\r\n\r\n## pull git js bot repo\r\nif [ \"$(ls -A \/mnt\/server)\" ]; then\r\n echo -e \"\/mnt\/server directory is not empty.\"\r\n if [ -d .git ]; then\r\n echo -e \".git directory exists\"\r\n if [ -f .git\/config ]; then\r\n echo -e \"loading info from git config\"\r\n ORIGIN=$(git config --get remote.origin.url)\r\n else\r\n echo -e \"files found with no git config\"\r\n echo -e \"closing out without touching things to not break anything\"\r\n exit 10\r\n fi\r\n fi\r\n\r\n if [ \"${ORIGIN}\" == \"https:\/\/github.com\/Emerald-Services\/SupportBot.git\" ]; then\r\n echo \"pulling latest from github\"\r\n git pull\r\n fi\r\nelse\r\n echo -e \"\/mnt\/server is empty.\\ncloning files into repo\"\r\n if [ ${BETA} == \"1\" ]; then\r\n echo -e \"cloning beta branch\"\r\n git clone --single-branch --branch dev https:\/\/github.com\/Emerald-Services\/SupportBot.git .\r\n else\r\n echo -e \"cloning default branch\"\r\n git clone https:\/\/github.com\/Emerald-Services\/SupportBot.git .\r\n fi\r\n\r\nfi\r\n\r\necho \"Installing nodejs packages\"\r\nif [ -f \/mnt\/server\/package.json ]; then\r\n \/usr\/local\/bin\/npm i\r\nfi\r\n\r\necho -e \"install complete\"\r\nexit 0",
"container": "node:17-buster-slim",
"script": "#!\/bin\/bash\r\n# SupportBot Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\necho -e \"${DEV}\"\r\napt update\r\napt install -y git curl jq file unzip make gcc g++ python python-dev libtool\r\n\r\nmkdir -p \/mnt\/server\r\ncd \/mnt\/server\r\n\r\n## pull git js bot repo\r\nif [ \"$(ls -A \/mnt\/server)\" ]; then\r\n echo -e \"\/mnt\/server directory is not empty.\"\r\n if [ -d .git ]; then\r\n echo -e \".git directory exists\"\r\n if [ -f .git\/config ]; then\r\n echo -e \"loading info from git config\"\r\n ORIGIN=$(git config --get remote.origin.url)\r\n else\r\n echo -e \"files found with no git config\"\r\n echo -e \"closing out without touching things to not break anything\"\r\n exit 10\r\n fi\r\n fi\r\n\r\n if [ \"${ORIGIN}\" == \"https:\/\/github.com\/Emerald-Services\/SupportBot.git\" ]; then\r\n echo \"pulling latest from github\"\r\n git pull\r\n fi\r\nelse\r\n echo -e \"\/mnt\/server is empty.\\ncloning files into repo\"\r\n if [ ${BETA} == \"1\" ]; then\r\n echo -e \"cloning beta branch\"\r\n git clone --single-branch --branch dev https:\/\/github.com\/Emerald-Services\/SupportBot.git .\r\n else\r\n echo -e \"cloning default branch\"\r\n git clone https:\/\/github.com\/Emerald-Services\/SupportBot.git .\r\n fi\r\n\r\nfi\r\n\r\necho \"Installing nodejs packages\"\r\nif [ -f \/mnt\/server\/package.json ]; then\r\n \/usr\/local\/bin\/npm i\r\nfi\r\n\r\necho -e \"install complete\"\r\nexit 0",
"container": "ghcr.io/parkervcp/yolks:nodejs_24",
"entrypoint": "bash"
}
},
"variables": [
{
"name": "Beta",
"name": "Dev",
"description": "NOT RECOMMENDED: Downloads development branch of SupportBot",
"env_variable": "BETA",
"env_variable": "DEV",
"default_value": "0",
"user_viewable": true,
"user_editable": true,
"rules": "required|boolean"
"rules": "required|boolean",
"field_type": "text"
}
]
}
}