> For the complete documentation index, see [llms.txt](https://docs.credebl.id/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.credebl.id/docs/getting-started/local-deployment/studio.md).

# Studio

* Clone the studio repository:

```
git clone https://github.com/credebl/studio.git
```

```
cd studio
```

* Create a .env file and set the required environment variables as per the `.env.demo` file.
  * Update the Keycloak credentials

    * For older version (>v2.1.0)
      * **`PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`**
    * For newer version (v2.1.0)
      * **`NEXT_PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`**

    You can get this value from your platform environment variables or directly from the Keyclock dashboard.
  * In version v2.1.0, we have implemented NextAuth for SSO. To run the application, please refer to the `env.demo` file for the required NextAuth-related values.
  * `NEXTAUTH_SECRET` Generate this secret by referring [here](https://next-auth.js.org/configuration/options#nextauth_secret.) (Only for v 2.1.0).
  * Add the backend URL for `PUBLIC_ALLOW_DOMAIN`

    ```
    PUBLIC_ALLOW_DOMAIN=http://{your-ip}:{api-gateway-port}
    ```
* Build docker image:

```
docker build -t ui .
```

* Start Studio UI

```
docker run -d -p 3000:3000 --env-file .env --name UI-App ui
```

* Access the dockerized Studio UI by navigating to:

```
http://localhost:3000
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.credebl.id/docs/getting-started/local-deployment/studio.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
