diff --git a/content/docs/blueprint/index.mdx b/content/docs/blueprint/index.mdx index e6b8f63..310fd71 100644 --- a/content/docs/blueprint/index.mdx +++ b/content/docs/blueprint/index.mdx @@ -3,10 +3,29 @@ title: Blueprint Documentation description: A fork of Blueprint Framework that works for Pyrodactyl --- - -This fork is not maintained by Pyro Inc. Although there is `#blueprint-support` channel, please direction any questions, issues, or problems to @flyingcopper within the channel as I am the main maintainer of the project and to not interfere with Pyro maintainers. +

+ Banner with Blueprint Logo +

+ + +This fork is not maintained by Pyro Inc. For Blueprint-specific issues, please notify `@flyingcopper` in the `#blueprint-support` channel. I will do my best to help you out. Please don't ask any other maintainer for help as they are not responsible for Blueprint. + + + Learn how to install Blueprint on your server + + + Learn how to migrate your Blueprint installation to a new version + + + ## Dependencies diff --git a/content/docs/blueprint/installation/fresh-installation.mdx b/content/docs/blueprint/installation/fresh-installation.mdx new file mode 100644 index 0000000..887e4ff --- /dev/null +++ b/content/docs/blueprint/installation/fresh-installation.mdx @@ -0,0 +1,91 @@ +--- +title: Fresh Installation +description: Setup Blueprint using Docker from scratch to a fully functional system. +--- + +

+ Banner with Blueprint Logo +

+ + +Too lazy to read the whole guide?
+You can jump down to the [TLDR](#tldr) section if you want to get started right away. + + +## Getting Started +First, create a folder (ex. `pyrodactyl-panel-blueprint`) on your server in a safe location. This folder will be used to store all the files for Pyrodactyl and Blueprint. + +### Choosing Docker Compose File +Next, you will have to decide the docker-compose file you would like to use. You have two options: +* [`classic-docker-compose.yml`](https://github.com/pyrodactyl-oss/blueprint-docker/blob/main/classic-docker-compose.yml) - This stays as close to the original pterodactyl docker-compose file as possible. +* [`docker-compose.yml (recommended)`](https://github.com/pyrodactyl-oss/blueprint-docker/blob/main/docker-compose.yml) - This is a more improved version of the docker-compose file. It is recommended that you choose this file if you are not sure. + +Once you decide on the docker-compose file, you will have to download it to your server to the folder you created in the previous step. + + +The installation guide will be using the recommended docker-compose file. The process is the same for both files. + + +### Configuring Docker Compose File +As this guide will follow the recommended docker-compose file, you will have to also download the [`.env`](https://github.com/pyrodactyl-oss/blueprint-docker/blob/main/.env) file. + + +If you are using the `classic-docker-compose.yml`, there is no need to install this file. + + +The file should look like this: +```properties +BASE_DIR=/srv/pyrodactyl +# By default, you'd want to place your Wings config.yml file at /srv/pyrodactyl/wings/config.yml +# In general, such as with this and with certs, you'd want to look at your mounts in the docker-compose.yml file +# in order to know where to put things on the host system. +APP_NAME= +APP_ENV=production # "production" or "testing" +PANEL_PORT=443 +# If you want to allow port 80 as well, i.e. if you don't use Cloudflare to manage your DNS and +# automatically direct requests to https, you can add another port in the docker-compose.yml file +WINGS_PORT=8080 +WINGS_SFTP_PORT=2022 +# Domain for mail sections (if you're configuring email) +DOMAIN=example.com +# Recommended strength is a random 20 digit password with letters, numbers, and symbols +# You can use "openssl rand -base64 32" to generate a random password +MARIADB_ROOT_PASS= +MARIADB_USER_PASS= +VALKEY_PASS= +HASH_SALT= +... +``` + +You can make your adjustments now to the `.env` file. + +### Start Docker Containers +Once you have configured the docker-compose file, you can start the containers by running the following command: +```bash +docker compose up -d +``` + +### Creating Panel User +Now that the panel is running, its time to make your first panel user. This user will be the admin user for the panel. +```bash +docker compose exec panel php artisan p:user:make +``` + +Now, you can check that the panel is accessible using the IP address or domain of your server. + +## TLDR +```bash +mkdir pyrodactyl-panel-blueprint +cd pyrodactyl-panel-blueprint + +wget https://raw.githubusercontent.com/pyrodactyl-oss/blueprint-docker/main/docker-compose.yml +wget https://raw.githubusercontent.com/pyrodactyl-oss/blueprint-docker/main/.env + +# Edit the .env file to your liking +nano .env + +docker compose up -d +docker compose exec panel php artisan p:user:make +``` + +Now navigate to the IP or domain of your panel. \ No newline at end of file diff --git a/content/docs/blueprint/installation/index.mdx b/content/docs/blueprint/installation/index.mdx index 1bf46cc..bf172d1 100644 --- a/content/docs/blueprint/installation/index.mdx +++ b/content/docs/blueprint/installation/index.mdx @@ -3,14 +3,24 @@ title: Installation description: Learn how to get started with Blueprint --- + +For Blueprint-specific issues, please notify `@flyingcopper` in the `#blueprint-support` channel. I will do my best to help you out. Please don't ask any other maintainer for help as they are not responsible for Blueprint. + + -More installation instructions will be added in the future. For now, there is a native installation guide. +More installation instructions will be added in the future. For now, there is a native and Docker installation guide. + + Setup Blueprint using Docker from scratch to a fully functional system. + Setup Blueprint on Bare metal from Scratch @@ -18,12 +28,6 @@ More installation instructions will be added in the future. For now, there is a ## Coming Soon - - Setup Blueprint using Docker from scratch to a fully functional system. - It is highly recommended that you use the offical Blueprint page to configure your environment variables. diff --git a/content/docs/blueprint/migrations/docker.mdx b/content/docs/blueprint/migrations/docker.mdx new file mode 100644 index 0000000..c17b3e5 --- /dev/null +++ b/content/docs/blueprint/migrations/docker.mdx @@ -0,0 +1,19 @@ +--- +title: Docker Migration +description: Guide for migrating from Pyrodactyl to Pyrodactyl (Blueprint) using Docker +--- + +## Migrating from Pyrodactyl (Docker) + +Always make sure you take a backup of your Pterodactyl database and other relevant data. + + +If you already have Pyrodactyl running in Docker, simply update your panel image in your `docker-compose.yml` file: +```diff +-image: ghcr.io/pyrohost/pyrodactyl:main ++image: ghcr.io/pyrodactyl-oss/blueprint:latest +``` + + +Switching back from Blueprint to Pyrodactyl is not supported. We do not provide any support for this and cant guarantee that it will work. If you care about your data, **make a backup** before switching. + \ No newline at end of file diff --git a/content/docs/blueprint/migrations/index.mdx b/content/docs/blueprint/migrations/index.mdx new file mode 100644 index 0000000..4c9f2ec --- /dev/null +++ b/content/docs/blueprint/migrations/index.mdx @@ -0,0 +1,10 @@ +--- +title: Migrations +description: Comprehensive guides for migrating to Pyrodactyl from other game panels +--- + +This section provides detailed guides for migrating to Pyrodactyl (Blueprint), with different methods depending on your current setup. + + +For Blueprint-specific issues, please notify `@flyingcopper` in the `#blueprint-support` channel. I will do my best to help you out. Please don't ask any other maintainer for help as they are not responsible for Blueprint. + \ No newline at end of file