Choose a FiveM Plan
Pick a plan by player slots and CPU/RAM needs. Scale up as your community grows.
Set up, manage, and troubleshoot your FiveM server with step-by-step guides.
🚀 Getting Started
Access Your Game Panel
Use the welcome email to log in, view your server, console, IP:Port, and metrics.
Set Up txAdmin
Install/enable txAdmin, create a recipe or link an existing server.cfg, and secure admin access.
Create a Database & Connect (HeidiSQL)
Create MySQL, add a user, then connect via HeidiSQL and configure your framework (oxmysql/mysql-async).
⚙ Server Management
Edit server.cfg (License, OneSync, Slots)
Configure sv_licenseKey, sv_maxclients, OneSync, locale, banner, and convars.
Manage Resources / Addons
Upload to /resources, use ensure in server.cfg, watch console for errors.
Scheduled Tasks & Backups
Use Schedules to automate restarts, backups, and maintenance announcements.
Update Server Artifacts
Upload latest artifacts, adjust start script if needed, and test on a staging copy.
🧩 Advanced & Resources
Frameworks & DB (esx/qb/ox)
Import SQL, set mysql_connection_string, and check oxmysql/mysql-async status.
Live Console & Logs
Use txAdmin and the panel console to tail errors, restart resources, and ban/whitelist.
🧯 Troubleshooting
Players Can’t Join / Timeouts
Check license, artifacts, onesync, connection string, and resource errors.
Database Connection Failed
Verify host/port/user/pass, grants, SSL options, and resource DB driver.
Pick a plan by player slots, CPU priority, and RAM. You can scale instantly as your community grows.
- Starter: private/friends, testing, under 20 slots.
- Community: public listing, scripts/frameworks, 32–64 slots.
- Performance: heavy scripts/voice/radio, 64–128 slots, scheduled backups.
Tip: start small and upgrade from your Client Portal when needed.
Your welcome email includes panel credentials. From the panel you can start/stop, view console, manage files, and schedule tasks.
- Open the panel and sign in.
- Select your FiveM server → Console for live logs.
- Use Files to upload resources and edit
server.cfg. - Set up Schedules for restarts and backups.
txAdmin provides web management, player administration, recipes, and live console.
- In Startup, ensure your start command or entrypoint launches
FXServerwith txAdmin enabled (most BeamHost templates include this). - Start the server → watch console for a txAdmin URL and PIN on first run.
- Open the txAdmin URL, enter the PIN, create your admin account, and secure 2FA if offered.
- Create a server from a recipe or link an existing
server.cfglocation on disk. - In txAdmin → Settings, set your endpoints, banner, and basic perms.
Keep txAdmin behind a strong password. Limit who has “Master/Owner” perms.
Provision MySQL, connect with HeidiSQL, and configure oxmysql/mysql-async for frameworks.
- In your panel or client portal, create a new MySQL database and user. Note:
- Host (e.g.,
127.0.0.1or your DB host) - Port (usually
3306) - Database name, username, and password
- Host (e.g.,
- HeidiSQL → New session:
- Network type: MySQL (TCP/IP)
- Hostname: your DB host
- User / Password: from step 1
- Port: 3306
- Connect → right-click the database → Load SQL file to import framework SQL (ESX/QBCore/ox).
- In
server.cfg, set one of:# oxmysql (recommended) set mysql_connection_string "mysql://USER:PASS@HOST:3306/DBNAME?charset=utf8mb4" ensure oxmysql # mysql-async (legacy) set mysql_connection_string "server=HOST;database=DBNAME;userid=USER;password=PASS;charset=utf8mb4" ensure mysql-async - Restart the server. Check console for “connected to database” messages.
If your provider enforces SSL/TLS, add options like
&sslmode=REQUIRED or provider-specific flags to the connection string.Key settings that impact joinability and performance.
# Required
sv_licenseKey "YOUR_FIVEM_LICENSE_KEY"
sv_hostname "My FiveM Server"
sv_maxclients 64
# Enable OneSync (choose appropriate mode for your build)
set onesync on
# Language / banner / tags
sets locale "en-US"
sets sv_projectName "My FiveM Server"
sets sv_projectDesc "Serious RP | Active Staff"
sets banner_detail "https://example.com/banner.png"
sets banner_connecting "https://example.com/banner.png"
sets tags "roleplay,english,seriousrp"
# Optional convars
set sv_enforceGameBuild 2944
set sv_endpointprivacy true
# Resources
ensure mapmanager
ensure chat
ensure spawnmanager
# ... your custom resources:
ensure my_custom_resource
After changes, restart via txAdmin or the panel. Watch console for errors in resources started by
ensure.Install resources in /resources, then ensure them in server.cfg.
- Upload resource folders (each with
fxmanifest.lua) to/resources/[local]/(or another group). - Edit
server.cfgand addensure <resourceName>lines in the order needed (dependencies first). - Restart or refresh + start from console:
refresh start my_custom_resource stop my_custom_resource restart my_custom_resource - Watch console for errors like missing dependency, syntax errors, or DB connection issues.
Only run one version of a resource at a time. Remove duplicates and keep frameworks/resources updated to match your artifacts build.
Automate restarts, backups, and announcements with your panel’s Pterodactyl schedules.
- Schedules → Create New → set cron (Minute, Hour, DOM, Month, DOW).
- Add Tasks in order:
- Send command — e.g., txAdmin announcements:
txaBroadcast "Restart in 3 minutes…" - Backup — snapshot files; configure ignores (cache/).
- Power action — Restart.
- Send command — e.g., txAdmin announcements:
- Use Time offset to space tasks (seconds). Test with Run now.
Every day at 05:00
Minute: 0
Hour: 5
DOM: *
Month: *
DOW: *Every 6 hours (on the hour)
Minute: 0
Hour: */6
DOM: *
Month: *
DOW: *Tip: Announce via
txaBroadcast or your chat resource; avoid heavy tasks at peak hours.Stay compatible with frameworks/resources by keeping artifacts current.
- Stop the server.
- Backup the server files and database.
- Upload the new artifacts build to the server directory (per your template layout).
- Confirm start script points at the new binaries; update dependencies if required.
- Start and verify in console; roll back if breaking changes appear.
Keep framework and DB driver versions aligned with your artifacts build.
- Import framework SQL with HeidiSQL (users, jobs, items, etc.).
- Set your connection string for oxmysql or mysql-async (see Database guide).
- Ensure the DB driver starts before frameworks (e.g.,
ensure oxmysqlabove ESX/QBCore). - Check logs for missing columns/tables and apply required migrations.
When updating frameworks, read their release notes—many require specific artifact builds or convars.
Quickly pinpoint failing resources or missing dependencies.
- Use txAdmin console to monitor and issue
restart <resource>on the fly. - Panel console shows startup order and stack traces from Lua/JS.
- Check
/logsfolder (if present) or enable extra logging via convars when debugging.
Don’t ignore warnings about deprecated natives—update resources to avoid breakage in newer artifacts.
Systematically verify the essentials.
- Valid
sv_licenseKeyinserver.cfgand correct artifacts build. - OneSync enabled if your framework/resources require it (
set onesync on). - Connection string valid and DB driver started before frameworks.
- Resource errors: disable new resources and re-enable one by one.
- Confirm the connect address (IP:Port) and any firewall rules if applicable.
Common root causes and fixes.
- Wrong host/port or user/password; test via HeidiSQL.
- User lacks grants on the database; apply
ALL PRIVILEGESon that DB. - SSL/TLS required by provider; add SSL params to connection string.
- DB driver not started or wrong order; ensure before frameworks.
After changes, restart the server and watch for “connected” or specific SQL errors.
