> For the complete documentation index, see [llms.txt](https://doc.ozforensics.com/oz-knowledge/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.ozforensics.com/oz-knowledge/guides/administrator-guide/configuration/web-adapter.md).

# Web Adapter (Web SDK Backend) Configuration

Please note: this page covers the on-premise model of usage only.

{% hint style="warning" %}
If you use Oz Web SDK via SaaS, please contacts our engineers.
{% endhint %}

<figure><img src="https://2532558063-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5g6dgsxRbyrCvB0uAf8f%2Fuploads%2FF5FRVAlygIumOeT53ZMo%2Fcomponents-public-webadapter.svg?alt=media&amp;token=d8215ae3-7dce-4cfe-8241-1045cca83772" alt=""><figcaption></figcaption></figure>

Oz Liveness Web Adapter is the backend part of Web SDK and is set up via changes in the configuration file stored at the Oz Liveness Web Adapter server: `/core/app_config.json`

<details>

<summary>Please note: the Adapter guide covers the on-premise model of usage only.</summary>

Before you start, it is highly advisable that you get an access token.

1. Create a service account. Its access token is set to expire in 5 years.
2. Install Postman and [download](/oz-knowledge/guides/developer-guide/api/oz-api/postman-collections.md) the Oz API collection needed.
3. Authorize: send a`POST request {{host}}/api/authorize/auth`, where `{{host}}` stands for the API server address. In the request body, send the service account credentials: login and password. For more information, please refer to [this article](/oz-knowledge/guides/developer-guide/api/oz-api/use-cases/authentication.md).
4. The response to your request will contain the `access_token` parameter. Copy its value to the `api_token` parameter of the `/core/app_config.json` file. Set `api_use_token` to `config`. You're done.

</details>

Please find a sample for Oz Liveness Web SDK [here](https://gitlab.com/oz-forensics/oz-liveness-sample-web/-/blob/master/OzLivenessWebSDKSample.html). To make it work, replace `<web-adapter-url>` with the Web Adapter URL you've received from us.

For Angular and React, replace `https://<link>.ozforensics.com` in index.html.

* [Angular sample](https://gitlab.com/oz-forensics/oz-liveness-sample-web-angular)
* [React sample](https://gitlab.com/oz-forensics/oz-liveness-sample-web-react/-/tree/main/public)

{% content-ref url="/pages/0rE3mimHc0usEHZg9Pe0" %}
[Configuration File Settings](/oz-knowledge/guides/administrator-guide/configuration/web-adapter/configuration-file-settings.md)
{% endcontent-ref %}

{% content-ref url="/pages/sINBJ1eJLaoEVUtwEs6V" %}
[Configuration Using Environment Variables](/oz-knowledge/guides/administrator-guide/configuration/web-adapter/configuration-using-environment-variables.md)
{% endcontent-ref %}

{% content-ref url="/pages/rRiUDWTXHmiEeMZK6K2z" %}
[Server Configuration via Environment Variables](/oz-knowledge/guides/administrator-guide/configuration/web-adapter/server-configuration-via-environment-variables.md)
{% endcontent-ref %}


---

# 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://doc.ozforensics.com/oz-knowledge/guides/administrator-guide/configuration/web-adapter.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.
