Installation
This guide is for a working Paymenter site. You should have bought Vortexus from an authorized store (BuiltByBit or SourceXchange ).
Back up first
Take a full backup of the database and Paymenter files (and save .env) before you merge anything. If a step fails, restore from backup or ask support with the exact error message.
What you need
- SSH or file access to the Paymenter server
- Composer and PHP as required by your Paymenter version
- Node.js and npm (to build frontend assets, like stock Paymenter)
- Basic comfort running a few terminal commands from the Paymenter project root (the folder that contains
artisanandcomposer.json)
Before you start
- Put the site in maintenance mode if it is public (
php artisan down— optional but safer). - Read Storage folders so you know which directories to create after the merge.
- If you use Pterodactyl, skim Pterodactyl & Wings — you will configure Wings after install.
What is in the zip
Your package usually looks like this:
Vortexus-Module-For-Paymenter/
Core/ # Merge these into your Paymenter root (same folder as artisan)
app/
database/
themes/ # (and other paths as provided)
...
extensions/
Others/
VortexusMarketplace/
Servers/
VortexusWeb/Core/is not a second app. It is meant to be copied into your existing Paymenter tree so paths line up withapp/,database/, etc.extensions/matches Paymenter’s extension layout: Others for marketplace, Servers for the Pterodactyl-related package.
If your archive layout differs slightly, follow the publisher’s readme; the idea is always: merge Core into Paymenter root, then copy extensions into Paymenter’s extensions/ folder.
Step 1 — Merge Core/ into Paymenter
- Go to your Paymenter project root (where
composer.jsonandartisanare). - Copy or merge the contents of
Core/so files land in the same relative paths (e.g.Core/app/...→app/...). - If you use Git, use a branch and review the diff. If you edited Paymenter before, compare so you do not lose your edits.
Paymenter upgrades: If Paymenter released a newer version after your Vortexus build, check with the publisher which Paymenter version the module was tested with before you upgrade core.
Step 2 — Copy extensions
Copy the marketplace and web packages into Paymenter:
extensions/Others/VortexusMarketplace/
extensions/Servers/VortexusWeb/Folder names and depth must match Paymenter’s extension system.
Step 3 — Composer
Where: Paymenter project root.
What it does: Installs PHP dependencies and refreshes autoload so Laravel sees the new code.
composer install --no-dev --optimize-autoloaderUse composer update only if the module’s release notes tell you to. On production, avoid random upgrades.
Step 4 — Database migrations
Where: Paymenter project root.
What it does: Adds or updates database tables the module needs.
php artisan migrate --forceRead the output. If migration fails, stop, restore from backup, and contact support with the full error text.
Step 5 — Frontend build
Where: Paymenter project root.
What it does: Builds CSS/JS (Vite) so the admin and client UI load correctly.
npm ci
npm run buildIf your Paymenter docs say npm install instead of npm ci, follow your version. After build, deploy public/build (or your project’s build output) if your server does not build automatically.
Step 6 — Storage link
Where: Paymenter project root.
What it does: Creates the public/storage link so uploaded files are reachable in the browser.
php artisan storage:linkStep 7 — Marketplace media folders
Create the vortexus-marketplace folders before heavy admin uploads. See Storage folders for exact paths and permissions.
Step 8 — Pterodactyl & Wings (for server features)
If you use Vortexus Web, each Wings node must trust your Paymenter URL. Follow Pterodactyl & Wings.
Step 9 — Turn extensions on
In Paymenter Admin → Extensions (labels may vary by version):
- Enable Vortexus Marketplace (under Others).
- Enable Vortexus Web (under Servers).
If an extension is missing from the list, check folder paths and run:
composer dump-autoloadStep 10 — Go live and clear caches
php artisan upIf you use config caching in production, rebuild only after you confirm the app loads:
php artisan config:cache(Your runbook may also use route:cache — follow your host’s practice.)
Check your setup
- Admin opens without errors.
- Extensions show as enabled.
- Marketplace routes work as configured (e.g.
/marketplacefor guests or clients, depending on your setup). - A test service with Vortexus Web opens the embedded panel; console needs correct Wings
allowed_origins(see Pterodactyl page).
Common issues
| Problem | What to check |
|---|---|
| Class not found / autoload | Run composer dump-autoload from project root. |
| Migration error | Full error message in terminal; restore backup if stuck halfway. |
| White screen or missing styles | Run npm run build; check file permissions on public/build. |
| Uploads 404 | php artisan storage:link and Storage folders. |
Next step
Continue to Storage folders and Pterodactyl & Wings, then Usage.
Already running Vortexus? See Updating Vortexus and Changelog.
Need help? Support & purchase.