Install a FiveM resource by placing its complete resource directory inside the server’s resources tree, satisfying its declared dependencies and adding an ensure entry to the active server configuration. Then check both server and client logs. A downloaded script may also require a specific framework, database migration, game build or entitlement; copying files alone does not satisfy those requirements.
Before copying the resource
Use the resource author’s distribution and read its version-specific instructions. Confirm the framework and supported versions, required companion resources, database adapter and whether an SQL migration changes existing tables. Keep a backup of the files and database before installation. Do not run an unfamiliar installer or grant broad permissions just to silence an error.
1. Verify the directory and manifest
server-data/
resources/
[local]/
eh_hello/
fxmanifest.lua
server.luaThe bracketed directory groups resources. The actual resource here is eh_hello, with its manifest immediately inside that directory. A common packaging mistake is an extra nested folder such as eh_hello/eh_hello/fxmanifest.lua. On Linux, filename case matters; check references exactly rather than relying on behavior observed on Windows.
For an isolated learning example, create the two files below in a private test server. They demonstrate only a minimal server-side resource and are not a framework installer or a production script.
-- fxmanifest.lua
fx_version 'cerulean'
game 'gta5'
server_script 'server.lua'-- server.lua
print('[eh_hello] Resource started')2. Start dependencies before the resource
Install the required dependencies with their supported configuration. If the resource needs a database, apply its reviewed migration to a test database first and confirm that the configured account has only the access the application needs. Do not rerun installation SQL against a live database without understanding whether it deletes or duplicates data.
# In the active server.cfg, after required dependencies
ensure eh_helloA controlled restart verifies that the saved configuration works. When testing a newly added directory in an already running server, the console refresh command rescans resources; ensure eh_hello starts it if stopped or restarts it if running. That restart can interrupt players or in-memory work, so use a maintenance window for stateful resources.
# Server console, for the isolated example
refresh
ensure eh_helloHow to diagnose the first startup error
| Symptom | Check first | Avoid |
|---|---|---|
| Resource not found | Active resources directory, nesting and exact resource name | Editing a different profile’s server.cfg |
| Missing dependency or export | Required resource, compatible version and start order | Renaming resources to hide the mismatch |
| SQL connection or missing-table error | Private endpoint, credentials, schema and migration status | Making the database public or blindly reimporting SQL |
| File or script load error | Manifest paths, filename case and complete download | Mixing files from several releases |
| Entitlement or protected-asset error | Legitimate account/license association and author instructions | Bypassing protection or installing an untrusted replacement |
| Starts but feature fails | Client F8 log, permissions, prerequisites and configuration | Assuming a green started status proves full functionality |
3. Verify behavior, persistence and rollback
- For the sample, confirm the startup line appears in the server console. For a real resource, perform its documented functional check with a test player.
- Check client and server errors while exercising the feature. Verify permissions with a normal account as well as an administrator.
- For persistent features, make a test change, restart cleanly and confirm the expected state remains.
- If installation fails, stop the affected service and restore the matching pre-install files and database where schema or data changed. Removing an ensure line alone does not undo a database migration.
Keep the working resource version and configuration in your deployment notes. Use the FiveM backup guide for recovery planning and the hitch-warning guide if a functional resource introduces slow server ticks. FiveM hosting provides the deployment context; resource compatibility still needs checking for your chosen framework.
Sources and references
Hosting documentation. Publication and update dates reflect this edition.
Related articles
- How to Set Up a FiveM Server with txAdminFollow the Windows FXServer setup path, protect administration access and verify a clean base server before adding a roleplay framework.4 min read
- How to Back Up and Restore a FiveM Server and DatabaseProtect resources, txAdmin profiles and SQL state as one recoverable set, then prove the restore on an isolated instance.4 min read
- How to Diagnose FiveM Server Hitch WarningsCapture the right profiler trace, separate server work from client FPS, and test resource changes without guessing.3 min read
