@open-ic/openchat_openclaw 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/settings.local.json +8 -0
- package/README.md +15 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ An [OpenClaw](https://openclaw.ai) plugin that adds [OpenChat](https://oc.app) a
|
|
|
11
11
|
## Installation
|
|
12
12
|
|
|
13
13
|
```sh
|
|
14
|
-
openclaw
|
|
14
|
+
openclaw plugins install @open-ic/openchat_openclaw
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
## Setup
|
|
@@ -37,13 +37,13 @@ OC_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"
|
|
|
37
37
|
OC_USER_INDEX_CANISTER="<canister-id>"
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
| Variable
|
|
41
|
-
|
|
42
|
-
| `OC_PUBLIC_KEY`
|
|
43
|
-
| `OC_USER_INDEX_CANISTER`
|
|
44
|
-
| `OC_PRIVATE_KEY`
|
|
45
|
-
| `OC_IC_HOST`
|
|
46
|
-
| `OC_STORAGE_INDEX_CANISTER` | No
|
|
40
|
+
| Variable | Required | Default | Description |
|
|
41
|
+
| --------------------------- | --------- | ----------------------------- | ---------------------------------------------------- |
|
|
42
|
+
| `OC_PUBLIC_KEY` | Yes | — | OpenChat's ES256 public key for JWT verification |
|
|
43
|
+
| `OC_USER_INDEX_CANISTER` | Yes | — | OpenChat user index canister ID |
|
|
44
|
+
| `OC_PRIVATE_KEY` | See below | — | Bot private key PEM (alternative to config) |
|
|
45
|
+
| `OC_IC_HOST` | No | `https://icp-api.io` | Internet Computer host (override for local replicas) |
|
|
46
|
+
| `OC_STORAGE_INDEX_CANISTER` | No | `nbpzs-kqaaa-aaaar-qaaua-cai` | Storage index canister ID |
|
|
47
47
|
|
|
48
48
|
### 3. Configure the private key
|
|
49
49
|
|
|
@@ -78,9 +78,13 @@ openclaw gateway run
|
|
|
78
78
|
|
|
79
79
|
### 5. Register the bot on OpenChat
|
|
80
80
|
|
|
81
|
-
Once the gateway is running and reachable from the
|
|
81
|
+
Once the gateway is running and reachable from the browser, go to [oc.app](https://oc.app), run the `/register_bot` command from any chat. To register the bot you can give it the name and avatar of your choice and you will also need the following two details.
|
|
82
82
|
|
|
83
|
-
- **
|
|
83
|
+
- **Gateway endpoint origin**: `https://<your-gateway-host>:<gateway-port>`
|
|
84
84
|
- **Principal**: the value printed in step 1
|
|
85
85
|
|
|
86
|
-
OpenChat will call `GET /
|
|
86
|
+
OpenChat will call `GET /bot_definition` to verify your endpoint is reachable before completing registration, and `POST /execute_command` each time a user sends `/prompt`.
|
|
87
|
+
|
|
88
|
+
### 6. Install the bot as a direct chat.
|
|
89
|
+
|
|
90
|
+
Search for the bot you registered as if searching for a user. Install the bot as a direct chat (which involves accepting the required permissions). Start talking to the bot! Congratulations, you are now talking to OpenClaw directly from OpenChat.
|