Welcome to the LumenWEB public repository. Help us make our egg better by contributing to it.

Introduction

LumenWEB is a Pterodactyl egg that allows you to host websites easily!

You can find it at BuiltByBit, SourceXChange and here, in this GitHub repository.

Installation

LumenWEB installs the same way as any other Pterodactyl egg, you download the .json file and import it to your panel.

This section is WIP >..<

Building

To edit LumenWEB for your personal use/hosting use, you can follow this simple guide:

1. Clone the repository

   git clone https://github.com/LumenDevelopment/LumenWEB
   cd LumenWEB

2. Edit the required files

   LumenWEB
   ├── assets/ # Static files like branding
   │   └── LumenWEB_Banner.png
   ├── scripts/
   │   └── build.sh.example
   ├── src/
   │   ├── Dockerfile
   │   └── entrypoint.sh # Main entrypoint file
   │   ├── default/ # Default configurations
   │   │   ├── nginx.conf
   │   │   ├── php-fpm.conf
   │   │   └── php.ini
   │   ├── lib/
   │   │   ├── cloudflared.sh # Cloudflare tunnel logic
   │   │   ├── helper.sh # Useful functions
   │   │   ├── lang.sh # Colors, messages, etc...
   │   │   └── launch/ # Start scripts for different softwares
   │   │       ├── astro.sh
   │   │       ├── custom.sh
   │   │       ├── nextjs.sh
   │   │       ├── php.sh
   │   │       ├── python.sh
   │   │       ├── react.sh
   │   │       └── serve.sh
   ├── .gitignore
   ├── .runasptero.example # Definitions for RunAsPtero (see below, part 4.)
   ├── .shellcheckrc
   ├── LICENSE.md
   ├── LumenWEB.json # The Pterodactyl egg definition
   └── README.md
   

3. Build the image

   To build the docker image, edit scripts/build.sh.example and adapt the command there. Then run the renamed script: bash scripts/build.sh

4. Test it in Pterodactyl

Tip

I have made a small tool for testing docker images as they would work in Pterodactyl, without Pterodactyl! RunAsPtero

Important

If LumenWEB helped you, consider contributing to the repo :)

That's it for now, a better README.md soon™ >.<