> For the complete documentation index, see [llms.txt](https://prisma-logs.gitbook.io/prisma-logs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prisma-logs.gitbook.io/prisma-logs/docs/en/getting-started/installation.md).

# Installation

## What you need

* A FiveM server on a recent artifact (the resource uses Lua 5.4)
* An active Prisma Logs plan
* The IP of your server filled in under **Settings** in the panel

## Steps

1. Download the resource in the panel: **Settings → Download resource**.
2. Unzip the `prisma-logs` folder into your `resources` folder. Don't rename it, other scripts use the name `prisma-logs` for the export.
3. Add this to `server.cfg`, **after** your framework (ESX / QBCore) and ox\_inventory:

```cfg
ensure baseevents
ensure prisma-logs
```

4. Restart your server.

## What is in the folder

| File             | What it does                                                                                                                |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `fxmanifest.lua` | The resource manifest                                                                                                       |
| `config.lua`     | Your license key, the panel address and all settings. See [config.lua](/prisma-logs/docs/en/configuration/configuration.md) |
| `server.lua`     | License check, sending logs in batches, the export                                                                          |
| `autologs.lua`   | The [built-in logs](/prisma-logs/docs/en/configuration/built-in-logs.md)                                                    |
| `scanner.lua`    | The [script scan](/prisma-logs/docs/en/configuration/script-scan.md)                                                        |

{% hint style="warning" %}
Don't share your `config.lua`. Your license key is in it. Someone with your key can send logs to your panel if they also use your IP.
{% endhint %}

## Changing IP

Moving your server to another machine? Change the IP in the panel under **Settings** and press **Save**. The license check works on the new IP right away.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://prisma-logs.gitbook.io/prisma-logs/docs/en/getting-started/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.