> 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.md).

# Deployment Guide

***

### Deployables

The 1Key deployment package includes installers and configuration generators for each component:

* Auth Server installer and configuration generator
* Auth Agent installer and configuration generator
* Auth Manager installer and configuration generator

Contact your 1Kosmos representative to obtain the 1Key Setup package.

### Generating configuration files

Each 1Key component requires an `api_config.json` file. Configuration files are generated using the `generateconfig.exe` tool included in each component's folder.

### Auth Server configuration

The `api_config.json` file for the Auth Server creates the required MongoDB database and collection.

**Steps**

1. Open the **generateconfig authserver** folder.
2. Open the `config.json` file.
3. Enter the database connection string and database name, then save the file:

```json
{
  "address": "",
  "port": "443",
  "secure": true,
  "socket_type": "tcp",
  "license": "SDDxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "db_conn_string": "mongodb+srv://<userid>:<pwd>@blockid-mongo.rjcms.gcp.mongodb.net/",
  "db_name": "<db name>"
}
```

4. Double-click `generateconfig.exe`. The tool generates the `api_config.json` file.
5. Copy the generated `api_config.json` for use during Auth Server installation.

### Auth Agent configuration

The `api_config.json` file for the Auth Agent points the agent to an Auth Server.

**Steps**

1. Open the **generateconfig authagent** folder.
2. Open the `config.json` file.
3. Enter the tenant name in the `address` field and the API key, then save the file:

```json
{
  "address": "xxxxxx.1kosmos.net",
  "port": "443",
  "secure": true,
  "path": "/caas/sd",
  "auth_server": "1key_authserver",
  "socket_type": "tcp",
  "socket_port": "12500",
  "license": "SDDxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "api_key": "HFg6xxxxxxxxxxxxxxxxxxxx"
}
```

4. Double-click `generateconfig.exe`. The tool generates the `api_config.json` file.
5. Copy the generated `api_config.json` for use during Auth Agent installation.

#### Auth Manager configuration

The `api_config.json` file for the Auth Manager points the manager to an Auth Server.

**Steps**

1. Open the **generateconfig authmanager** folder.
2. Open the `config.json` file.
3. Enter the tenant name in the `address` field, then save the file:

```json
{
  "agent_config": {
    "address": "localhost",
    "port": "21777"
  },
  "authx_config": {
    "address": "xxxxxx.1kosmos.net",
    "port": "443",
    "secure": true,
    "path": "/caas/sd",
    "auth_server": "1key_authserver",
    "license": "SDDxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}
```

4. Double-click `generateconfig.exe`. The tool generates the `api_config.json` file.
5. Copy the generated `api_config.json` for use during Auth Manager installation.


---

# 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.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.