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

# Installation & setup

Match the framework, dependencies, database, and integrations.

## Before starting

Read the complete product instructions. Record supported frameworks and versions, libraries, database adapter, inventory, target, and menu systems. Standalone support means the features described by that product.

{% stepper %}
{% step %}

### Prepare dependencies

Install the required versions from their intended sources. Start libraries and the framework before the script. Check the actual resource folder names.
{% endstep %}

{% step %}

### Set up the database only if required

If an SQL file is supplied and its import is required, back up the database, select the correct database, and follow the documented steps. Do not repeatedly import the same file as a troubleshooting guess.
{% endstep %}

{% step %}

### Edit the supported configuration

Use the supplied configuration and integration files. Set the framework, inventory, language, and other required options. Filenames and available settings vary by product.
{% endstep %}

{% step %}

### Start and test the core feature

Start the script, read the first server error, and test the main feature using the required permissions. Test additional integrations afterwards.
{% endstep %}
{% endstepper %}

## Client versus server

The **server console** often reveals startup, database, export, and permission errors. The **client F8 console** can show UI, client-script, and model-loading errors. Both may be relevant to a ticket.

A client event does not automatically belong in a server file. Use only the documented integration interfaces for that product.

## Common failure points

* Incorrect framework or unsupported version.
* Missing library or incorrect startup order.
* Export name or resource folder name does not match.
* The database adapter runs but connects to the wrong database.
* A required item or job is missing.
* ACE, job, or administration permissions are not configured correctly.

[Scripts & integrations](/studioworks-docs/troubleshooting/script-integration.md) · [Escrow & licensing](/studioworks-docs/troubleshooting/escrow-licensing.md)

{% hint style="warning" %}
Do not grant blanket administrator access to make one command work. Configure only the permissions required by the product instructions.
{% endhint %}

***

[StudioWorks Store](https://tebex.studio-works.net/) · [Discord & Support](https://discord.gg/UmqU67rp4v)


---

# 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://studioworks.gitbook.io/studioworks-docs/scripts/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.