Skip to content

Qbox Installation Docs

Using Pterodactyl Panel, txAdmin, and the Official Qbox Recipe

1. Initial Server Configuration

  1. Once the server has booted for the first time, stop it from the panel.
  2. Go to your server’s file manager or connect via SFTP.

2. Launch txAdmin

  1. Start your server again.
  2. Watch the Console Output—you’ll see txAdmin provide a setup link (http://127.0.0.1:40120/auth…).
  3. Copy this link and open it in your browser.
  4. Follow the txAdmin onboarding steps (set up a username, password, and configure basic server settings).

3. Import the Qbox Recipe

  1. In txAdmin, click on “Server Management” > “Recipe Setup”.

  2. When prompted to select a recipe, paste the following URL in the “Custom Recipe URL” field:

https://raw.githubusercontent.com/Qbox-project/txAdminRecipe/main/qbox.yaml

  1. Click Next/Continue.

  2. Review the recipe details and confirm.

  3. This will automatically download and install Qbox and all recommended resources.

  4. Wait for the process to finish.

  5. This may take a few minutes as it installs all dependencies.

4. Finalize & Start Your Qbox Server

  1. Once the recipe setup completes, txAdmin will prompt you to start the server.
  2. Click Start Server in txAdmin or on the Pterodactyl panel.

  3. Monitor the Console for errors.

  4. On first boot, assets and resources will be downloaded/installed.

5. Connect & Configure

  1. When the server is running, copy your server IP and port.
  2. Start FiveM and connect using Direct Connect.
  3. If you need to adjust Qbox config, edit your server.cfg or Qbox config files via the file manager or SFTP.
  4. For more advanced features, visit the Qbox documentation and txAdmin docs.

Troubleshooting

  • Ports: Ensure the correct ports are open (default FiveM port: 30120, txAdmin: 40120).
  • Permissions: If files fail to download/install, check your file/folder permissions.

  • Server Won’t Start?

  • Check the console log for missing dependencies or typos in server.cfg.

  • Make sure the server license key is valid and present.

Credits & Resources

https://raw.githubusercontent.com/Qbox-project/txAdminRecipe/main/qbox.yaml * FiveM Documentation: https://docs.fivem.net/ * txAdmin Documentation: https://docs.fivem.net/docs/txadmin/

Need Help?