> For the complete documentation index, see [llms.txt](https://docs.1kosmos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.1kosmos.com/authentication/1key-biometric/deployment-guide/auth-server-installation.md).

# Auth Server installation

***

### Installation steps

{% stepper %}
{% step %}
Copy the authserver folder to your workstation.

{% endstep %}

{% step %}
Copy the api\_config.json file generated in the configuration step into the authserver folder.

{% endstep %}

{% step %}
Double-click AuthServer-0.0.18.exe to start the installation.

{% endstep %}

{% step %}
Select I accept the agreement and click Next.

{% endstep %}

{% step %}
Proceed with the default path and click Next.

{% endstep %}

{% step %}
Proceed with the default name and click Next.

{% endstep %}

{% step %}
Click Install.

{% endstep %}

{% step %}
Select No, I will restart the computer later.

{% endstep %}

{% step %}
Open the Auth Server external URL/IP in a browser to verify installation.

{% endstep %}
{% endstepper %}

{% hint style="info" %}
If the Auth Server page does not display in your browser, it may be blocked by the local Windows firewall. Follow the firewall rule section below.
{% endhint %}

### Configure firewall rule

If the local Windows firewall blocks the Auth Server, create an inbound rule.

**Steps**

{% stepper %}
{% step %}
Search for **Windows Defender Firewall with Advanced Security** and open it.

{% endstep %}

{% step %}
Right-click **Inbound Rules** and click **New Rule**.

{% endstep %}

{% step %}
Choose the **Port** option and click **Next**.

{% endstep %}

{% step %}
Choose **TCP** and enter ports **443, 12500**.

{% endstep %}

{% step %}
Click **Allow the connection**.

{% endstep %}

{% step %}
Check **Domain**, **Private**, and **Public**.

{% endstep %}

{% step %}
Enter the name **Auth Server Web Socket** and click **Finish**.
{% endstep %}
{% endstepper %}

### Configure the AuthX UI dashboard

After the Auth Server is reachable in the browser:

1. Open the Auth Server external IP in a browser.
2. Enter the URL as **https** and the tenant name (for example, `demo3-pilot.1kosmos.net`), with port **443**.
3. Enter the following details and click **Next**:

* **Username** — 1K internal DB user ID
* **Password** — Password of the above user. This creates an admin account in the Auth Server using the same user.
* **Community ID** — Your community ID
* **Tenant ID** — Your tenant ID
* **License key** — Service ext license key

4. Enable the **Default Group** checkbox, enter a Default Group name, and click **Save**.
5. Click **OK** on the confirmation screen.
6. Log in using the same 1K internal DB credentials entered above.

After logging in, complete the post-installation configuration:

* Add Key Bank details
* Add the API key for Auth Agent
* Upload the device template to authorize devices


---

# 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.1kosmos.com/authentication/1key-biometric/deployment-guide/auth-server-installation.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.