Skip to content

Commit

Permalink
Merge pull request #151 from katalon-studio/TES-5236
Browse files Browse the repository at this point in the history
[TES-5236] Update readme and docker env
  • Loading branch information
quidl authored Nov 28, 2023
2 parents 22eee52 + c2a037c commit 049af5a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ agentName=My Agent
email=<email>
apikey=<api_key>
serverUrl=https://analytics.katalon.com/
teamId=<team_id>
organizationId=<organization_id>
```

- Supported options:
Expand All @@ -30,7 +30,7 @@ teamId=<team_id>
| email | The email of the Katalon account used to log into the Katalon TestOps. |
| apikey | The API Key used to log into the Katalon TestOps. The API key can be generated and retrieved from [here](https://analytics.katalon.com/user/apikey). For more info read the [docs](https://docs.katalon.com/katalon-analytics/docs/ka-api-key.html#katalon-api-keys-usage). |
| serverUrl | The Katalon TestOps' URL. |
| teamId | The ID of the Katalon TestOps team to integrate the Katalon Agent into. The agent is shared among members and projects within a team. |
| organizationId | The ID of the Katalon TestOps organization to integrate the Katalon Agent into. The agent is shared among members and projects within an organization that the agent linked to. |
| uuid | The ID used to identify the agent. It is generated by the Katalon Agent on the first run and should not be specified manually or modified for any reason. |

| Optional Option | Description |
Expand Down Expand Up @@ -67,7 +67,7 @@ Note: On Linux and MacOS, you might need to add execute permission (`chmode u+x

## Generate the configuration file
- The `agentconfig` file can be generated or updated by running `config` command with additional arguments.
- E.g. `node cli.js config --server-url https://analytics.katalon.com --username <email> --apikey <api_key> --teamid <team_id> --agent-name my-agent`
- E.g. `node cli.js config --server-url https://analytics.katalon.com --username <email> --apikey <api_key> --organizationid <organization_id> --agent-name my-agent`
- If an `agentconfig` has been created, the existing configuration will be overridden with the new value.
- Show the usage of the `config` command with `-h` option. E.g. `node cli.js config -h`.

Expand Down
2 changes: 1 addition & 1 deletion agentconfig_template
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ agentName=
email=
apikey=
serverUrl=
teamId=
organizationId=
keepFiles=false
logLevel=INFO
2 changes: 1 addition & 1 deletion cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ program
serverUrl: command.serverUrl,
email: command.username,
apikey: command.apikey,
teamId: command.organizationid,
organizationId: command.organizationid,
agentName: command.agentName,
configPath: command.config,
proxy: command.proxy,
Expand Down
2 changes: 1 addition & 1 deletion docker/scripts/agent.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ cd $KATALON_AGENT_DIR
--server-url "$SERVER_URL" \
--username "$KATALON_USERNAME" \
--apikey "$KATALON_API_KEY" \
--teamid "$TEAM_ID" \
--organizationid "$ORGANIZATION_ID" \
--agent-name "$AGENT_NAME" \
--proxy "$PROXY" \
--log-level "$LOG_LEVEL" \
Expand Down

0 comments on commit 049af5a

Please sign in to comment.