Overview

Piximy Panel lets you run your FiveM server from a browser or phone, and works on QB-Core, Qbox and Meteo. The pack has two parts that work together:

Requirements

• A Linux VPS running your FiveM server (Ubuntu 22.04 or 24.04 recommended)
• Node.js 18 or newer (node -v)
• oxmysql on the game server
• QB-Core, Qbox or Meteo with ox_inventory, qb-inventory, ps-inventory, lj-inventory or Meteo's inventory
• Your game database login
• Optional: a domain name for HTTPS

Install piximy-connect

1. Download your purchase from the Cfx.re Portal under your purchased assets. Your server must use a license key from the same Cfx.re account you bought with.
2. Put the piximy-connect folder in your resources folder. Upload every file, including the hidden .fxap file.
3. Open piximy-connect/config.lua. The defaults work for most servers. Change Config.CoreResource or Config.InventoryResource only if you renamed them.
4. Leave server.cfg for now. The panel setup prints the two lines to add.

On start the server console shows a line like [Piximy Connect] framework: qbox (core: qbx_core) | inventory: ox_inventory (ox). It creates its own database tables, so there is no SQL to run.

Install the panel

1. Unzip piximy-panel.zip from your download and upload the folder to your VPS, for example /home/fivem/piximy-panel.
2. Install its packages and run setup:

cd /home/fivem/piximy-panel
npm install
node setup.js

Setup asks for your server name, time zone, server folder, database login and an owner login. It tests the database and detects QB, Qbox or Meteo.

3. Add the two lines setup prints to server.cfg, after oxmysql and your core:

set piximy_secret "the-secret-setup-printed"
ensure piximy-connect

4. Restart the game server, then run npm start in the panel folder.
5. Open http://YOUR-VPS-IP:40150/control-panel/ and log in as the owner.

Keep it running

sudo tee /etc/systemd/system/piximy-panel.service >/dev/null <<EOF
[Unit]
Description=Piximy Panel
After=network.target mariadb.service

[Service]
WorkingDirectory=/home/fivem/piximy-panel
ExecStart=/usr/bin/node server.js
Restart=always
User=fivem

[Install]
WantedBy=multi-user.target
EOF
sudo systemctl enable --now piximy-panel

Change the folder and User= to match your VPS. Check it with systemctl status piximy-panel.

Domain and HTTPS

Log in at https://panel.yourserver.com/control-panel/ with nginx and a free Let's Encrypt certificate.

1. At your domain provider, add an A record: name panel, value = your VPS IP.
2. Install nginx and certbot: sudo apt install -y nginx certbot python3-certbot-nginx
3. Create /etc/nginx/sites-available/piximy-panel:

server {
    listen 80;
    server_name panel.yourserver.com;
    location /control-panel/ { proxy_pass http://127.0.0.1:40150; proxy_set_header Host $host; proxy_set_header X-Forwarded-For $remote_addr; client_max_body_size 300m; }
    location /api/           { proxy_pass http://127.0.0.1:40150; proxy_set_header Host $host; proxy_set_header X-Forwarded-For $remote_addr; client_max_body_size 300m; }
    location /socket.io/     { proxy_pass http://127.0.0.1:40150; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; }
    location = /             { return 302 /control-panel/; }
}

4. Turn it on and get HTTPS:

sudo ln -s /etc/nginx/sites-available/piximy-panel /etc/nginx/sites-enabled/
sudo nginx -t && sudo systemctl reload nginx
sudo certbot --nginx -d panel.yourserver.com

5. Add PX_LISTEN_HOST=127.0.0.1 to the panel's .env and restart it, so the panel is only reachable through your domain.

Using Cloudflare? Set the record to DNS only while certbot runs, then turn the proxy back on with SSL mode Full (strict).

Game host servers

Game hosts like Zap-Hosting run FiveM only, not Node.js. Rent a small Linux VPS for the panel and connect it to your game database:

• Ask your host to allow remote database access, and use those details in node setup.js.
• In piximy-connect/config.lua, set Config.PanelUrl = 'https://panel.yourserver.com'.
• Setup needs a server folder: point it at an empty folder with a resources folder inside.

On a separate machine the panel can't reach your server files, so Config Editor, Script Settings, Maps & MLOs, the jobs file editor and the Meteo settings pages won't work. Everything else does.

Sections

The panel only shows sections your server can use, and prints which are off when it starts.

Force a section on or off in .env, then restart the panel:

PX_MODULES_ON=weather
PX_MODULES_OFF=leaderboards,motels

Panel settings (.env)

Setup writes .env for you. Never share .env or staff.json: they hold your passwords.

Game settings (config.lua)

The secret is not in config.lua. It goes in server.cfg as set piximy_secret "…".

For developers

Write a line to the panel's Logs page from your own scripts (server side):

exports['piximy-connect']:Log('player', 'bought_house', source, { house = 'Vinewood 12', price = 250000 })

Add your own panel action:

exports['piximy-connect']:RegisterCommandHandler('give_vip', function(data, cmd)
    local id = tonumber(data.id)
    if not id or not GetPlayerName(id) then return false, 'Player is not online' end
    -- your code
    return true
end)

Tables created by piximy-connect: piximy_logs, piximy_ops_commands, piximy_damage_logs, piximy_connect_info.

Updating

1. Back up your database (Owner Control → Backups, or mysqldump).
2. Replace the panel files but keep .env, staff.json, data/ and storage/.
3. Run npm install, then restart the panel.
4. Replace piximy-connect but keep your config.lua, then restart the game server.

Troubleshooting

Still stuck? Get support.