> 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/contribute/setup/studio/admin-portal.md).

# Admin portal

***

Clone the platform-admin repository:

<pre><code><strong>git clone https://github.com/credebl/platform-admin.git &#x26;&#x26; cd platform-admin/
</strong></code></pre>

Create a .env file and set the required environment variables as per the `.env.example` file.

* Update the following environment variables:

  * `NEXT_PUBLIC_PLATFORM_CLIENT_ID`
  * `NEXT_PUBLIC_PLATFORM_CLIENT_SECRET`

  You can obtain these values from the platform environment variables `ADMIN_KEYCLOAK_ID` and `ADMIN_KEYCLOAK_SECRET`, or directly from the **Keycloak Dashboard** by navigating to the **`adminClient`** client within your realm.
* Before updating these variables, ensure that an Admin Portal client has been created in Keycloak. If the client does not exist, refer to the [**Create Admin Client**](https://docs.credebl.id/docs/contribute/setup/service-setup#create-adminclient) guide for setup instructions.
* When updating the `.env` file, set `NEXT_PUBLIC_PLATFORM_CLIENT_ID` and `NEXT_PUBLIC_PLATFORM_CLIENT_SECRET` using the raw Keycloak client ID and client secret values. Do not use encrypted or encoded values.
* The Platform admin portal requires bun package manager ensure the dependency is installed.
* For NextAuth SSO, 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 v2.1.0).
* Add the backend URL for `PUBLIC_ALLOW_DOMAIN`

  ```
  PUBLIC_ALLOW_DOMAIN=http://{your-ip}:{api-gateway-port}
  ```
* Use the admin credentials generated from platform seed script to login and access the UI.&#x20;

Install dependencies and start the Admin Portal UI:

```
bun i 
bun run start
```

Access the Admin Portal UI by navigating to:

Note: the port could be different based on configuration and availability.&#x20;

```
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/contribute/setup/studio/admin-portal.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.