From fd0ba900e2ba1275910c3cada1f4105f85e53ed9 Mon Sep 17 00:00:00 2001 From: PatrickYu17 Date: Tue, 21 Nov 2023 14:08:33 -0800 Subject: [PATCH] Update Installation.md Basically added the information from the blueprint main readme into the docs --- docs/pages/getting-started/Installation.md | 56 +++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/docs/pages/getting-started/Installation.md b/docs/pages/getting-started/Installation.md index 0686c16..af53d8b 100644 --- a/docs/pages/getting-started/Installation.md +++ b/docs/pages/getting-started/Installation.md @@ -1,2 +1,56 @@ # Installation -

Learn how to install Blueprint on your Pterodactyl instance


\ No newline at end of file +

Learn how to install Blueprint on your Pterodactyl instance


+ +
+ + +### **Prerequisites:** + +**What you need:** +* [The latest release of Blueprint.](https://github.com/teamblueprint/main/releases/latest) +* [`unzip`](https://pkgs.org/download/unzip) +* [`zip`](https://pkgs.org/download/zip) +* [`curl`](https://github.com/curl/curl) +* [`git`](https://github.com/git/git) +* [`nodejs`](https://nodejs.org) (20.x or later) +* [`yarn`](https://yarnpkg.com/) +* Linux and Pterodactyl knowledge. +* Common sense. + +### **Installation Steps** + +**1.** Navigate to your Pterodactyl folder. (most likely `/var/www/pterodactyl`) + +**2.** Install NodeJS, NPM and Yarn using the following commands. This assumes you are running Pterodactyl on Ubuntu or Debian-based systems. +```sh +sudo apt-get install -y ca-certificates curl gnupg +sudo mkdir -p /etc/apt/keyrings +curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg +echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list +apt-get update +apt-get install -y nodejs +npm i -g yarn +yarn +``` +**3.** Download [the latest release of Blueprint](https://github.com/teamblueprint/main/releases/latest) and extract it (stable build) or pull the files via git (bleeding-edge build). + +**4.** If you haven't already, place the Blueprint files inside of your Pterodactyl folder. (common location is `/var/www/pterodactyl`) + +**5.** Run the Blueprint installation script. This runs the commands required for Blueprint to function correctly. If your Pterodactyl folder is not `/var/www/pterodactyl` you may need to put `_FOLDER="/path/to/pterodactyl"` in front of `bash blueprint.sh`. +```sh +chmod +x blueprint.sh +bash blueprint.sh +``` +6. After waiting for the installation script to finish, open up your Pterodactyl admin panel and click on the puzzle icon in the top right of the website to verify your installation. + +
+ +### **Need Installation Help?** + +Join our [Discord](https://discord.gg/vmQCKV5NsM)! You can create a forum post in our Discord and our community can help you out with your installation. \ No newline at end of file