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:

{
  "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>"
}

1. Double-click generateconfig.exe. The tool generates the api_config.json file.

2. 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:

{
  "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"
}

1. Double-click generateconfig.exe. The tool generates the api_config.json file.

2. 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:

{
  "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"
  }
}

1. Double-click generateconfig.exe. The tool generates the api_config.json file.

2. Copy the generated api_config.json for use during Auth Manager installation.